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.
Copy file name to clipboardExpand all lines: README.md
+20-16Lines changed: 20 additions & 16 deletions
Original file line number
Diff line number
Diff line change
@@ -64,7 +64,7 @@ A valid (read: that follows this interface) IPFS core implementation, must expos
64
64
65
65
##### `JavaScript` - ipfs.object.new([callback])
66
66
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][]
68
68
69
69
If no `callback` is passed, a promise is returned.
70
70
@@ -84,13 +84,13 @@ If no `callback` is passed, a promise is returned.
84
84
85
85
- Object, with format `{ Data: <data>, Links: [] }`
86
86
- Buffer, requiring that the encoding is specified on the options. If no encoding is specified, Buffer is treated as the Data field
`options` is a optional argument of type object, that can contain the following properties:
90
90
91
91
-`enc`, the encoding of the Buffer (json, yml, etc), if passed a Buffer.
92
92
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][]
94
94
95
95
If no `callback` is passed, a promise is returned.
96
96
@@ -106,7 +106,7 @@ If no `callback` is passed, a promise is returned.
`multihash` is a [multihash]() which can be passed as:
109
+
`multihash` is a [multihash][] which can be passed as:
110
110
111
111
- Buffer, the raw Buffer of the multihash (or of and encoded version)
112
112
- String, the toString version of the multihash (or of an encoded version)
@@ -115,7 +115,7 @@ If no `callback` is passed, a promise is returned.
115
115
116
116
-`enc`, the encoding of multihash (base58, base64, etc), if any.
117
117
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][]
119
119
120
120
If no `callback` is passed, a promise is returned.
121
121
@@ -126,7 +126,7 @@ If no `callback` is passed, a promise is returned.
`multihash` is a [multihash]() which can be passed as:
215
+
`multihash` is a [multihash][] which can be passed as:
216
216
217
217
- Buffer, the raw Buffer of the multihash (or of and encoded version)
218
218
- String, the toString version of the multihash (or of an encoded version)
@@ -223,7 +223,7 @@ If no `callback` is passed, a promise is returned.
223
223
224
224
-`enc`, the encoding of multihash (base58, base64, etc), if any.
225
225
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.
227
227
228
228
If no `callback` is passed, a promise is returned.
229
229
@@ -239,7 +239,7 @@ If no `callback` is passed, a promise is returned.
`multihash` is a [multihash]() which can be passed as:
242
+
`multihash` is a [multihash][] which can be passed as:
243
243
244
244
- Buffer, the raw Buffer of the multihash (or of and encoded version)
245
245
- String, the toString version of the multihash (or of an encoded version)
@@ -250,7 +250,7 @@ If no `callback` is passed, a promise is returned.
250
250
251
251
-`enc`, the encoding of multihash (base58, base64, etc), if any.
252
252
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.
254
254
255
255
If no `callback` is passed, a promise is returned.
256
256
@@ -266,7 +266,7 @@ If no `callback` is passed, a promise is returned.
`multihash` is a [multihash]() which can be passed as:
269
+
`multihash` is a [multihash][] which can be passed as:
270
270
271
271
- Buffer, the raw Buffer of the multihash (or of and encoded version)
272
272
- String, the toString version of the multihash (or of an encoded version)
@@ -277,7 +277,7 @@ If no `callback` is passed, a promise is returned.
277
277
278
278
-`enc`, the encoding of multihash (base58, base64, etc), if any.
279
279
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.
281
281
282
282
If no `callback` is passed, a promise is returned.
283
283
@@ -293,7 +293,7 @@ If no `callback` is passed, a promise is returned.
`multihash` is a [multihash]() which can be passed as:
296
+
`multihash` is a [multihash][] which can be passed as:
297
297
298
298
- Buffer, the raw Buffer of the multihash (or of and encoded version)
299
299
- String, the toString version of the multihash (or of an encoded version)
@@ -304,6 +304,10 @@ If no `callback` is passed, a promise is returned.
304
304
305
305
-`enc`, the encoding of multihash (base58, base64, etc), if any.
306
306
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.
308
308
309
309
If no `callback` is passed, a promise is returned.
0 commit comments