You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
This repository was archived by the owner on Mar 10, 2020. It is now read-only.
CDN-based IPFS API provides the `IpfsApi` constructor as a method of the global `window` object. Example:
142
143
143
144
```js
144
-
var ipfs =window.IpfsApi('localhost', '5001')
145
+
constipfs=window.IpfsApi('localhost', '5001')
145
146
```
146
147
147
148
If you omit the host and port, the API will parse `window.host`, and use this information. This also works, and can be useful if you want to write apps that can be run from multiple different gateways:
-[`ipfs.files.cat(ipfsPath, [options], [callback])`](https://github.com/ipfs/interface-ipfs-core/blob/master/SPEC/FILES.md#filescat). Alias to `ipfs.cat`.
-[`ipfs.files.get(ipfsPath, [options], [callback])`](https://github.com/ipfs/interface-ipfs-core/blob/master/SPEC/FILES.md#filesget). Alias to `ipfs.get`.
Adding to the methods defined by [`interface-ipfs-core`](https://github.com/ipfs/interface-ipfs-core), `js-ipfs-api` exposes a set of extra utility methods. These utility functions are scoped behind the `ipfs.util`.
365
369
366
370
Complete documentation for these methods is coming with: https://github.com/ipfs/js-ipfs-api/pull/305
367
371
368
-
##### Add files or entire directories from the FileSystem to IPFS
369
-
370
-
> `ipfs.util.addFromFs(path, option, callback)`
371
-
372
-
Reads a file or folder from `path` on the filesystem and adds it to IPFS. Options:
373
-
-**recursive**: If `path` is a directory, use option `{ recursive: true }` to add the directory and all its sub-directories.
374
-
-**ignore**: To exclude fileglobs from the directory, use option `{ ignore: ['ignore/this/folder/**', 'and/this/file'] }`.
375
-
-**hidden**: hidden/dot files (files or folders starting with a `.`, for example, `.git/`) are not included by default. To add them, use the option `{ hidden: true }`.
@@ -440,22 +387,6 @@ This contains an object with the crypto primitives
440
387
441
388
This contains an object with the is-ipfs utilities to help identifying IPFS resources
442
389
443
-
### Callbacks and Promises
444
-
445
-
If you do not pass in a callback all API functions will return a `Promise`. For example:
446
-
447
-
```js
448
-
ipfs.id()
449
-
.then((id) => {
450
-
console.log('my id is: ', id)
451
-
})
452
-
.catch((err) => {
453
-
console.log('Fail: ', err)
454
-
})
455
-
```
456
-
457
-
This relies on a global `Promise` object. If you are in an environment where that is not yet available you need to bring your own polyfill.
458
-
459
390
## Development
460
391
461
392
### Testing
@@ -466,10 +397,10 @@ We run tests by executing `npm test` in a terminal window. This will run both No
466
397
467
398
The js-ipfs-api is a work in progress. As such, there's a few things you can do right now to help out:
468
399
469
-
***[Check out the existing issues](https://github.com/ipfs/js-ipfs-api/issues)**!
470
-
***Perform code reviews**. More eyes will help a) speed the project along b) ensure quality and c) reduce possible future bugs.
471
-
***Add tests**. There can never be enough tests. Note that interface tests exist inside [`interface-ipfs-core`](https://github.com/ipfs/interface-ipfs-core/tree/master/js/src).
472
-
***Contribute to the [FAQ repository](https://github.com/ipfs/faq/issues)** with any questions you have about IPFS or any of the relevant technology. A good example would be asking, 'What is a merkledag tree?'. If you don't know a term, odds are, someone else doesn't either. Eventually, we should have a good understanding of where we need to improve communications and teaching together to make IPFS and IPN better.
400
+
-**[Check out the existing issues](https://github.com/ipfs/js-ipfs-api/issues)**!
401
+
-**Perform code reviews**. More eyes will help a) speed the project along b) ensure quality and c) reduce possible future bugs.
402
+
-**Add tests**. There can never be enough tests. Note that interface tests exist inside [`interface-ipfs-core`](https://github.com/ipfs/interface-ipfs-core/tree/master/js/src).
403
+
-**Contribute to the [FAQ repository](https://github.com/ipfs/faq/issues)** with any questions you have about IPFS or any of the relevant technology. A good example would be asking, 'What is a merkledag tree?'. If you don't know a term, odds are, someone else doesn't either. Eventually, we should have a good understanding of where we need to improve communications and teaching together to make IPFS and IPN better.
0 commit comments