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

Commit 36cf442

Browse files
Alan Shawdaviddias
Alan Shaw
authored and
daviddias
committed
fix: code blocks for the code
License: MIT Signed-off-by: Alan Shaw <alan.shaw@protocol.ai>
1 parent 0ca86fa commit 36cf442

16 files changed

+203
-201
lines changed

‎SPEC/BITSWAP.md

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

88
> Returns the wantlist, optionally filtered by peer ID
99
10-
#### `Go` **WIP**
10+
#### Go **WIP**
1111

12-
#### `JavaScript` - ipfs.bitswap.wantlist([peerId], [callback])
12+
#### JavaScript - `ipfs.bitswap.wantlist([peerId], [callback])`
1313

1414
`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:
1515

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

3535
> Show diagnostic information on the bitswap agent.
3636
37-
##### `Go` **WIP**
37+
##### Go **WIP**
3838

39-
##### `JavaScript` - ipfs.bitswap.stat([callback])
39+
##### JavaScript - `ipfs.bitswap.stat([callback])`
4040

4141
Note: `bitswap.stat` and `stats.bitswap` can be used interchangeably.
4242

‎SPEC/BLOCK.md

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

99
> Get a raw IPFS block.
1010
11-
##### `Go` **WIP**
11+
##### Go **WIP**
1212

13-
##### `JavaScript` - ipfs.block.get(cid, [options, callback])
13+
##### JavaScript - `ipfs.block.get(cid, [options], [callback])`
1414

1515
`cid` is a [cid][cid] which can be passed as:
1616

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

4545
> Stores input as an IPFS block.
4646
47-
##### `Go` **WIP**
47+
##### Go **WIP**
4848

49-
##### `JavaScript` - ipfs.block.put(block [, options], [callback])
49+
##### JavaScript - `ipfs.block.put(block, [options], [callback])`
5050

5151
Where `block` can be:
5252

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

115115
> Print information of a raw IPFS block.
116116
117-
##### `Go` **WIP**
117+
##### Go **WIP**
118118

119-
##### `JavaScript` - ipfs.block.stat(cid, [callback])
119+
##### JavaScript - `ipfs.block.stat(cid, [callback])`
120120

121121
`cid` is a [cid][cid] which can be passed as:
122122

‎SPEC/BOOTSTRAP.md

+8-8
Original file line numberDiff line numberDiff line change
@@ -14,21 +14,21 @@
1414

1515
> Add a peer address to the bootstrap list
1616
17-
##### `Go` **WIP**
17+
##### Go **WIP**
1818

19-
##### `JavaScript` - ipfs.bootstrap.add(addr, [opts,] callback)
19+
##### JavaScript - `ipfs.bootstrap.add(addr, [options], [callback])`
2020

2121
- `addr` is a [multiaddr](https://github.com/multiformats/js-multiaddr) to a peer node
22-
- `opts.default` if true, add the default peers to the list
22+
- `options.default` if true, add the default peers to the list
2323
- `callback` must follow `function (err, res) {}` signature, where `err` is an error if the operation was not successful. `res.Peers` is an array of added addresses.
2424

2525
#### `bootstrap.list`
2626

2727
> List all peer addresses in the bootstrap list
2828
29-
##### `Go` **WIP**
29+
##### Go **WIP**
3030

31-
##### `JavaScript` - ipfs.bootstrap.list(callback)
31+
##### JavaScript - `ipfs.bootstrap.list([callback])``
3232

3333
- `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.
3434

@@ -37,10 +37,10 @@
3737

3838
> Remove a peer address from the bootstrap list
3939
40-
##### `Go` **WIP**
40+
##### Go **WIP**
4141

42-
##### `JavaScript` - ipfs.bootstrap.rm(peer, [opt,] callback)
42+
##### JavaScript - `ipfs.bootstrap.rm(peer, [options], [callback])`
4343

4444
- `addr` is a [multiaddr](https://github.com/multiformats/js-multiaddr) to a peer node
45-
- `opts.all` if true, remove all peers from the list
45+
- `options.all` if true, remove all peers from the list
4646
- `callback` must follow `function (err, res) {}` signature, where `err` is an error if the operation was not successful. `res.Peers` is an array of removed addresses.

‎SPEC/CONFIG.md

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

99
> Returns the currently being used config. If the daemon is off, it returns the stored config.
1010
11-
##### `Go` **WIP**
11+
##### Go **WIP**
1212

13-
##### `JavaScript` - ipfs.config.get([key, callback])
13+
##### JavaScript - `ipfs.config.get([key], [callback])`
1414

1515
`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.
1616

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

3636
> Adds or replaces a config value.
3737
38-
##### `Go` **WIP**
38+
##### Go **WIP**
3939

40-
##### `JavaScript` - ipfs.config.set(key, value, [callback])
40+
##### JavaScript - `ipfs.config.set(key, value, [callback])`
4141

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

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

6767
> Adds or replaces a config file.
6868
69-
##### `Go` **WIP**
69+
##### Go **WIP**
7070

71-
##### `JavaScript` - ipfs.config.replace(config, [callback])
71+
##### JavaScript - `ipfs.config.replace(config, [callback])`
7272

7373
`config` is a JSON object that contains the new config.
7474

‎SPEC/DAG.md

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

1111
> Store an IPLD format node
1212
13-
##### `Go` **WIP**
13+
##### Go **WIP**
1414

15-
##### `JavaScript` - ipfs.dag.put(dagNode, [options], [callback])
15+
##### JavaScript - `ipfs.dag.put(dagNode, [options], [callback])`
1616

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

4747
> Retrieve an IPLD format node
4848
49-
##### `Go` **WIP**
49+
##### Go **WIP**
5050

51-
##### `JavaScript` - ipfs.dag.get(cid, [path], [options], [callback])
51+
##### JavaScript - `ipfs.dag.get(cid, [path], [options], [callback])`
5252

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

118118
> Enumerate all the entries in a graph
119119
120-
##### `Go` **WIP**
120+
##### Go **WIP**
121121

122-
##### `JavaScript` - ipfs.dag.tree(cid, [path], [options], [callback])
122+
##### JavaScript - `ipfs.dag.tree(cid, [path], [options], [callback])`
123123

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

‎SPEC/DHT.md

+12-12
Original file line numberDiff line numberDiff line change
@@ -11,9 +11,9 @@
1111

1212
> Retrieve the Peer Info of a reachable node in the network.
1313
14-
##### `Go` **WIP**
14+
##### Go **WIP**
1515

16-
##### `JavaScript` - ipfs.dht.findpeer(peerId, [callback])
16+
##### JavaScript - `ipfs.dht.findpeer(peerId, [callback])`
1717

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

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

3838
> Retrieve the providers for content that is addressed by an hash.
3939
40-
##### `Go` **WIP**
40+
##### Go **WIP**
4141

42-
##### `JavaScript` - ipfs.dht.findprovs(hash, [options], callback])
42+
##### JavaScript - `ipfs.dht.findprovs(hash, [options], [callback])`
4343

4444
Where `hash` is a multihash.
4545

@@ -64,9 +64,9 @@ A great source of [examples][] can be found in the tests for this API.
6464

6565
> Retrieve a value from DHT
6666
67-
##### `Go` **WIP**
67+
##### Go **WIP**
6868

69-
##### `JavaScript` - ipfs.dht.get(key, [callback])
69+
##### JavaScript - `ipfs.dht.get(key, [callback])`
7070

7171
Where `key` is a string.
7272

@@ -86,9 +86,9 @@ A great source of [examples][] can be found in the tests for this API.
8686

8787
> Announce to the network that you are providing given values.
8888
89-
##### `Go` **WIP**
89+
##### Go **WIP**
9090

91-
##### `JavaScript` - ipfs.dht.provide(cid, [callback])
91+
##### JavaScript - `ipfs.dht.provide(cid, [callback])`
9292

9393
Where `cid` is a CID or array of CIDs.
9494

@@ -108,9 +108,9 @@ A great source of [examples][] can be found in the tests for this API.
108108

109109
> Store a value on the DHT
110110
111-
##### `Go` **WIP**
111+
##### Go **WIP**
112112

113-
##### `JavaScript` - ipfs.dht.put(key, value, [callback])
113+
##### JavaScript - `ipfs.dht.put(key, value, [callback])`
114114

115115
Where `key` is a string and `value` can be of any type.
116116

@@ -130,9 +130,9 @@ A great source of [examples][] can be found in the tests for this API.
130130

131131
> Queries the network for the 'closest peers' to a given key. 'closest' is defined by the rules of the underlying Peer Routing mechanism.
132132
133-
##### `Go` **WIP**
133+
##### Go **WIP**
134134

135-
##### `JavaScript` - ipfs.dht.query(peerId, [callback])
135+
##### JavaScript - `ipfs.dht.query(peerId, [callback])`
136136

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

0 commit comments

Comments
 (0)