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.
Tidy up the API docs by removing refs to Go as well as JavaScript (since this is the JS interface repo).
refs #423
refs #435
License: MIT
Signed-off-by: Alan Shaw <alan.shaw@protocol.ai>
If you want to run these tests against a go-ipfs daemon, checkout [ipfs-http-client](https://github.com/ipfs/js-ipfs-http-client) and run test tests:
63
61
64
62
```
@@ -69,8 +67,6 @@ npm test
69
67
70
68
## Usage
71
69
72
-
### JavaScript
73
-
74
70
Install `interface-ipfs-core` as one of the dependencies of your project and as a test file. Then, using `mocha` (for Node.js) or a test runner with compatible API, do:
75
71
76
72
```js
@@ -156,7 +152,7 @@ tests.repo(createCommon, { only: ['should do a thing'] })
156
152
157
153
## API
158
154
159
-
In order to be considered "valid", an IPFS core implementation must expose the API described in [/SPEC](/SPEC). You can also use this loose spec as documentation for consuming the core APIs. Here is an outline of the contents of that directory:
155
+
In order to be considered "valid", an IPFS core implementation must expose the API described in [/SPEC](/SPEC). You can also use this loose spec as documentation for consuming the core APIs. Here is an outline of the contents of that directory:
160
156
161
157
-**Files**
162
158
-[files](/SPEC/FILES.md)
@@ -166,15 +162,17 @@ In order to be considered "valid", an IPFS core implementation must expose the
`callback` must follow `function (err, list) {}` signature, where `err` is an error if the operation was not successful. `list` is an Object containing the following keys:
-`callback` must follow `function (err, res) {}` signature, where `err` is an error if the operation was not successful. `res.Peers` is an array of addresses.
`key` is the key of the value that should be fetched from the config file. If no key is passed, then the whole config should be returned. `key` should be of type String.
16
14
@@ -35,9 +33,7 @@ A great source of [examples][] can be found in the tests for this API.
0 commit comments