Skip to content
This repository was archived by the owner on Mar 10, 2020. It is now read-only.

Commit 01d7660

Browse files
author
Alan Shaw
authored
docs: remove references to Go (#442)
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 <[email protected]>
1 parent d39458e commit 01d7660

17 files changed

+102
-292
lines changed

README.md

+6-8
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ The API is presented with both Node.js and Go primitives. However, there are no
3535

3636
- [JavaScript IPFS implementation](https://github.com/ipfs/js-ipfs)
3737
- [JavaScript IPFS HTTP Client Library](https://github.com/ipfs/js-ipfs-api)
38-
- Soon™, go-ipfs, go-ipfs-api, java-ipfs-api, python-ipfs-api and others will implement it as well.
38+
- [JavaScript IPFS postMessage proxy](https://github.com/ipfs-shipyard/ipfs-postmsg-proxy)
3939

4040
Send in a PR if you find or write one!
4141

@@ -57,8 +57,6 @@ In JavaScript land:
5757
npm install interface-ipfs-core
5858
```
5959

60-
In Go land:
61-
6260
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:
6361

6462
```
@@ -69,8 +67,6 @@ npm test
6967

7068
## Usage
7169

72-
### JavaScript
73-
7470
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:
7571

7672
```js
@@ -156,7 +152,7 @@ tests.repo(createCommon, { only: ['should do a thing'] })
156152
157153
## API
158154

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:
160156

161157
- **Files**
162158
- [files](/SPEC/FILES.md)
@@ -166,15 +162,17 @@ In order to be considered "valid", an IPFS core implementation must expose the
166162
- [dag](/SPEC/DAG.md)
167163
- [object](/SPEC/OBJECT.md)
168164
- [pin](/SPEC/PIN.md)
165+
- [**Name**](/SPEC/NAME.md)
169166
- **Network**
170167
- [bootstrap](/SPEC/BOOSTRAP.md)
171-
- [bitswap (not spec'ed yet)](/SPEC/BITSWAP.md)
172-
- [dht (not spec'ed yet)](/SPEC/DHT.md)
168+
- [bitswap](/SPEC/BITSWAP.md)
169+
- [dht](/SPEC/DHT.md)
173170
- [pubsub](/SPEC/PUBSUB.md)
174171
- [swarm](/SPEC/SWARM.md)
175172
- **Node Management**
176173
- [Miscellaneous](/SPEC/MISCELLANEOUS.md)
177174
- [config](/SPEC/CONFIG.md)
175+
- [key](/SPEC/KEY.md)
178176
- [stats](/SPEC/STATS.md)
179177
- [repo](/SPEC/REPO.md)
180178
- [**Types**](/SPEC/TYPES.md)

SPEC/BITSWAP.md

+2-6
Original file line numberDiff line numberDiff line change
@@ -7,9 +7,7 @@
77

88
> Returns the wantlist, optionally filtered by peer ID
99
10-
#### Go **WIP**
11-
12-
#### JavaScript - `ipfs.bitswap.wantlist([peerId], [callback])`
10+
#### `ipfs.bitswap.wantlist([peerId], [callback])`
1311

1412
`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:
1513

@@ -34,9 +32,7 @@ ipfs.bitswap.wantlist(peerId, (err, list) => console.log(list))
3432

3533
> Show diagnostic information on the bitswap agent.
3634
37-
##### Go **WIP**
38-
39-
##### JavaScript - `ipfs.bitswap.stat([callback])`
35+
##### `ipfs.bitswap.stat([callback])`
4036

4137
Note: `bitswap.stat` and `stats.bitswap` can be used interchangeably.
4238

SPEC/BLOCK.md

+3-9
Original file line numberDiff line numberDiff line change
@@ -8,9 +8,7 @@
88

99
> Get a raw IPFS block.
1010
11-
##### Go **WIP**
12-
13-
##### JavaScript - `ipfs.block.get(cid, [options], [callback])`
11+
##### `ipfs.block.get(cid, [options], [callback])`
1412

1513
`cid` is a [cid][cid] which can be passed as:
1614

@@ -44,9 +42,7 @@ A great source of [examples][] can be found in the tests for this API.
4442

4543
> Stores input as an IPFS block.
4644
47-
##### Go **WIP**
48-
49-
##### JavaScript - `ipfs.block.put(block, [options], [callback])`
45+
##### `ipfs.block.put(block, [options], [callback])`
5046

5147
Where `block` can be:
5248

@@ -114,9 +110,7 @@ A great source of [examples][] can be found in the tests for this API.
114110

115111
> Print information of a raw IPFS block.
116112
117-
##### Go **WIP**
118-
119-
##### JavaScript - `ipfs.block.stat(cid, [callback])`
113+
##### `ipfs.block.stat(cid, [callback])`
120114

121115
`cid` is a [cid][cid] which can be passed as:
122116

SPEC/BOOTSTRAP.md

+3-9
Original file line numberDiff line numberDiff line change
@@ -14,9 +14,7 @@
1414

1515
> Add a peer address to the bootstrap list
1616
17-
##### Go **WIP**
18-
19-
##### JavaScript - `ipfs.bootstrap.add(addr, [options], [callback])`
17+
##### `ipfs.bootstrap.add(addr, [options], [callback])`
2018

2119
- `addr` is a [multiaddr](https://github.com/multiformats/js-multiaddr) to a peer node
2220
- `options.default` if true, add the default peers to the list
@@ -26,9 +24,7 @@
2624

2725
> List all peer addresses in the bootstrap list
2826
29-
##### Go **WIP**
30-
31-
##### JavaScript - `ipfs.bootstrap.list([callback])``
27+
##### `ipfs.bootstrap.list([callback])``
3228

3329
- `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.
3430

@@ -37,9 +33,7 @@
3733

3834
> Remove a peer address from the bootstrap list
3935
40-
##### Go **WIP**
41-
42-
##### JavaScript - `ipfs.bootstrap.rm(peer, [options], [callback])`
36+
##### `ipfs.bootstrap.rm(peer, [options], [callback])`
4337

4438
- `addr` is a [multiaddr](https://github.com/multiformats/js-multiaddr) to a peer node
4539
- `options.all` if true, remove all peers from the list

SPEC/CONFIG.md

+3-9
Original file line numberDiff line numberDiff line change
@@ -8,9 +8,7 @@
88

99
> Returns the currently being used config. If the daemon is off, it returns the stored config.
1010
11-
##### Go **WIP**
12-
13-
##### JavaScript - `ipfs.config.get([key], [callback])`
11+
##### `ipfs.config.get([key], [callback])`
1412

1513
`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.
1614

@@ -35,9 +33,7 @@ A great source of [examples][] can be found in the tests for this API.
3533

3634
> Adds or replaces a config value.
3735
38-
##### Go **WIP**
39-
40-
##### JavaScript - `ipfs.config.set(key, value, [callback])`
36+
##### `ipfs.config.set(key, value, [callback])`
4137

4238
`key` is the key value that will be added or replaced (in case of the value already). `key` should be of type String.
4339

@@ -66,9 +62,7 @@ A great source of [examples][] can be found in the tests for this API.
6662

6763
> Adds or replaces a config file.
6864
69-
##### Go **WIP**
70-
71-
##### JavaScript - `ipfs.config.replace(config, [callback])`
65+
##### `ipfs.config.replace(config, [callback])`
7266

7367
`config` is a JSON object that contains the new config.
7468

SPEC/DAG.md

+3-9
Original file line numberDiff line numberDiff line change
@@ -10,9 +10,7 @@
1010

1111
> Store an IPLD format node
1212
13-
##### Go **WIP**
14-
15-
##### JavaScript - `ipfs.dag.put(dagNode, [options], [callback])`
13+
##### `ipfs.dag.put(dagNode, [options], [callback])`
1614

1715
- `dagNode` - a DAG node that follows one of the supported IPLD formats.
1816
- `options` - a object that might contain the following values:
@@ -46,9 +44,7 @@ A great source of [examples][] can be found in the tests for this API.
4644

4745
> Retrieve an IPLD format node
4846
49-
##### Go **WIP**
50-
51-
##### JavaScript - `ipfs.dag.get(cid, [path], [options], [callback])`
47+
##### `ipfs.dag.get(cid, [path], [options], [callback])`
5248

5349
- `cid` - can be one of the following:
5450
- a [CID](https://github.com/ipfs/js-cid) instance.
@@ -117,9 +113,7 @@ A great source of [examples][] can be found in the tests for this API.
117113

118114
> Enumerate all the entries in a graph
119115
120-
##### Go **WIP**
121-
122-
##### JavaScript - `ipfs.dag.tree(cid, [path], [options], [callback])`
116+
##### `ipfs.dag.tree(cid, [path], [options], [callback])`
123117

124118
- `cid` - can be one of the following:
125119
- a [CID](https://github.com/ipfs/js-cid) instance.

SPEC/DHT.md

+6-18
Original file line numberDiff line numberDiff line change
@@ -11,9 +11,7 @@
1111

1212
> Retrieve the Peer Info of a reachable node in the network.
1313
14-
##### Go **WIP**
15-
16-
##### JavaScript - `ipfs.dht.findPeer(peerId, [callback])`
14+
##### `ipfs.dht.findPeer(peerId, [callback])`
1715

1816
Where `peerId` is a IPFS/libp2p Id from [PeerId](https://github.com/libp2p/js-peer-id) type.
1917

@@ -39,9 +37,7 @@ A great source of [examples][] can be found in the tests for this API.
3937

4038
> Retrieve the providers for content that is addressed by an hash.
4139
42-
##### Go **WIP**
43-
44-
##### JavaScript - `ipfs.dht.findProvs(hash, [options], [callback])`
40+
##### `ipfs.dht.findProvs(hash, [options], [callback])`
4541

4642
Where `hash` is a multihash.
4743

@@ -67,9 +63,7 @@ A great source of [examples][] can be found in the tests for this API.
6763

6864
> Retrieve a value from DHT
6965
70-
##### Go **WIP**
71-
72-
##### JavaScript - `ipfs.dht.get(key, [callback])`
66+
##### `ipfs.dht.get(key, [callback])`
7367

7468
Where `key` is a Buffer.
7569

@@ -89,9 +83,7 @@ A great source of [examples][] can be found in the tests for this API.
8983

9084
> Announce to the network that you are providing given values.
9185
92-
##### Go **WIP**
93-
94-
##### JavaScript - `ipfs.dht.provide(cid, [callback])`
86+
##### `ipfs.dht.provide(cid, [callback])`
9587

9688
Where `cid` is a CID or array of CIDs.
9789

@@ -111,9 +103,7 @@ A great source of [examples][] can be found in the tests for this API.
111103

112104
> Store a value on the DHT
113105
114-
##### Go **WIP**
115-
116-
##### JavaScript - `ipfs.dht.put(key, value, [callback])`
106+
##### `ipfs.dht.put(key, value, [callback])`
117107

118108
Where `key` is a Buffer and `value` is a Buffer.
119109

@@ -133,9 +123,7 @@ A great source of [examples][] can be found in the tests for this API.
133123

134124
> Queries the network for the 'closest peers' to a given key. 'closest' is defined by the rules of the underlying Peer Routing mechanism.
135125
136-
##### Go **WIP**
137-
138-
##### JavaScript - `ipfs.dht.query(peerId, [callback])`
126+
##### `ipfs.dht.query(peerId, [callback])`
139127

140128
Where `peerId` is a IPFS/libp2p Id of type [PeerId](https://github.com/libp2p/js-peer-id).
141129

0 commit comments

Comments
 (0)