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

Commit c3bcf39

Browse files
committed
use markdown footnotes for DAGNode
1 parent cbb2531 commit c3bcf39

File tree

1 file changed

+11
-8
lines changed

1 file changed

+11
-8
lines changed

README.md

Lines changed: 11 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -64,7 +64,7 @@ A valid (read: that follows this interface) IPFS core implementation, must expos
6464

6565
##### `JavaScript` - ipfs.object.new([callback])
6666

67-
`callback` must follow `function (err, node) {}` signature, where `err` is an error if the operation was not successful and `node` is a MerkleDAG node of the type [DAGNode](https://github.com/vijayee/js-ipfs-merkle-dag/blob/master/src/dag-node.js)
67+
`callback` must follow `function (err, node) {}` signature, where `err` is an error if the operation was not successful and `node` is a MerkleDAG node of the type [DAGNode][]
6868

6969
If no `callback` is passed, a promise is returned.
7070

@@ -84,13 +84,13 @@ If no `callback` is passed, a promise is returned.
8484

8585
- Object, with format `{ Data: <data>, Links: [] }`
8686
- Buffer, requiring that the encoding is specified on the options. If no encoding is specified, Buffer is treated as the Data field
87-
- [DAGNode](https://github.com/vijayee/js-ipfs-merkle-dag/blob/master/src/dag-node.js).
87+
- [DAGNode][]
8888

8989
`options` is a optional argument of type object, that can contain the following properties:
9090

9191
- `enc`, the encoding of the Buffer (json, yml, etc), if passed a Buffer.
9292

93-
`callback` must follow `function (err, node) {}` signature, where `err` is an error if the operation was not successful and `node` is a MerkleDAG node of the type [DAGNode](https://github.com/vijayee/js-ipfs-merkle-dag/blob/master/src/dag-node.js)
93+
`callback` must follow `function (err, node) {}` signature, where `err` is an error if the operation was not successful and `node` is a MerkleDAG node of the type [DAGNode][]
9494

9595
If no `callback` is passed, a promise is returned.
9696

@@ -115,7 +115,7 @@ If no `callback` is passed, a promise is returned.
115115

116116
- `enc`, the encoding of multihash (base58, base64, etc), if any.
117117

118-
`callback` must follow `function (err, node) {}` signature, where `err` is an error if the operation was not successful and `node` is a MerkleDAG node of the type [DAGNode](https://github.com/vijayee/js-ipfs-merkle-dag/blob/master/src/dag-node.js)
118+
`callback` must follow `function (err, node) {}` signature, where `err` is an error if the operation was not successful and `node` is a MerkleDAG node of the type [DAGNode][]
119119

120120
If no `callback` is passed, a promise is returned.
121121

@@ -223,7 +223,7 @@ If no `callback` is passed, a promise is returned.
223223

224224
- `enc`, the encoding of multihash (base58, base64, etc), if any.
225225

226-
`callback` must follow `function (err, node) {}` signature, where `err` is an error if the operation was not successful and `node` is a MerkleDAG node of the type [DAGNode](https://github.com/vijayee/js-ipfs-merkle-dag/blob/master/src/dag-node.js) that resulted by the operation of adding a Link.
226+
`callback` must follow `function (err, node) {}` signature, where `err` is an error if the operation was not successful and `node` is a MerkleDAG node of the type [DAGNode][] that resulted by the operation of adding a Link.
227227

228228
If no `callback` is passed, a promise is returned.
229229

@@ -250,7 +250,7 @@ If no `callback` is passed, a promise is returned.
250250

251251
- `enc`, the encoding of multihash (base58, base64, etc), if any.
252252

253-
`callback` must follow `function (err, node) {}` signature, where `err` is an error if the operation was not successful and `node` is a MerkleDAG node of the type [DAGNode](https://github.com/vijayee/js-ipfs-merkle-dag/blob/master/src/dag-node.js) that resulted by the operation of adding a Link.
253+
`callback` must follow `function (err, node) {}` signature, where `err` is an error if the operation was not successful and `node` is a MerkleDAG node of the type [DAGNode][] that resulted by the operation of adding a Link.
254254

255255
If no `callback` is passed, a promise is returned.
256256

@@ -277,7 +277,7 @@ If no `callback` is passed, a promise is returned.
277277

278278
- `enc`, the encoding of multihash (base58, base64, etc), if any.
279279

280-
`callback` must follow `function (err, node) {}` signature, where `err` is an error if the operation was not successful and `node` is a MerkleDAG node of the type [DAGNode](https://github.com/vijayee/js-ipfs-merkle-dag/blob/master/src/dag-node.js) that resulted by the operation of adding a Link.
280+
`callback` must follow `function (err, node) {}` signature, where `err` is an error if the operation was not successful and `node` is a MerkleDAG node of the type [DAGNode][] that resulted by the operation of adding a Link.
281281

282282
If no `callback` is passed, a promise is returned.
283283

@@ -304,6 +304,9 @@ If no `callback` is passed, a promise is returned.
304304

305305
- `enc`, the encoding of multihash (base58, base64, etc), if any.
306306

307-
`callback` must follow `function (err, node) {}` signature, where `err` is an error if the operation was not successful and `node` is a MerkleDAG node of the type [DAGNode](https://github.com/vijayee/js-ipfs-merkle-dag/blob/master/src/dag-node.js) that resulted by the operation of adding a Link.
307+
`callback` must follow `function (err, node) {}` signature, where `err` is an error if the operation was not successful and `node` is a MerkleDAG node of the type [DAGNode][] that resulted by the operation of adding a Link.
308308

309309
If no `callback` is passed, a promise is returned.
310+
311+
312+
[DAGNode]: https://github.com/vijayee/js-ipfs-merkle-dag

0 commit comments

Comments
 (0)