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 Aug 11, 2021. It is now read-only.
Updates `ipfs-repo` which has `ipld-block@0.11.0`
Fixes JSDoc linting errors and typos.
BREAKING CHANGE: updates ipld-block to 0.11.0 which is not compatible
with earlier versions (fails `expect(v11Block).to.deep.equal(v10Block)` for example)
Copy file name to clipboardExpand all lines: src/index.js
+7-7Lines changed: 7 additions & 7 deletions
Original file line number
Diff line number
Diff line change
@@ -78,8 +78,8 @@ class IPLDResolver {
78
78
* @param {Object} [options] - Options is an object with the following properties.
79
79
* @param {AbortSignal} [options.signal] - A signal that can be used to abort any long-lived operations that are started as a result of this operation.
80
80
* @returns {Iterable.<Promise.<{remainderPath: string, value}>>} - Returns an async iterator of all the IPLD Nodes that were traversed during the path resolving. Every element is an object with these fields:
81
-
* - `remainderPath`: the part of the path that wasn’t resolved yet.
82
-
* - `value`: the value where the resolved path points to. If further traversing is possible, then the value is a CID object linking to another IPLD Node. If it was possible to fully resolve the path, value is the value the path points to. So if you need the CID of the IPLD Node you’re currently at, just take the value of the previously returned IPLD Node.
81
+
* - `remainderPath`: the part of the path that wasn’t resolved yet.
82
+
* - `value`: the value where the resolved path points to. If further traversing is possible, then the value is a CID object linking to another IPLD Node. If it was possible to fully resolve the path, value is the value the path points to. So if you need the CID of the IPLD Node you’re currently at, just take the value of the previously returned IPLD Node.
83
83
*/
84
84
resolve(cid,path,options){
85
85
if(!CID.isCID(cid)){
@@ -169,7 +169,7 @@ class IPLDResolver {
169
169
* @param {Object} node - The deserialized IPLD node that should be inserted.
170
170
* @param {number} format - The multicodec of the format that IPLD Node should be encoded in.
171
171
* @param {Object} [userOptions] - Options is an object with the following properties.
172
-
* @param {number} [userOtions.hashAlg=hash algorithm of the given multicodec] - The hashing algorithm that is used to calculate the CID.
172
+
* @param {number} [userOptions.hashAlg=hash algorithm of the given multicodec] - The hashing algorithm that is used to calculate the CID.
173
173
* @param {number} [userOptions.cidVersion=1] - The CID version to use.
174
174
* @param {boolean} [userOptions.onlyHash=false] - If true the serialized form of the IPLD Node will not be passed to the underlying block store.
175
175
* @param {AbortSignal} [userOptions.signal] - A signal that can be used to abort any long-lived operations that are started as a result of this operation.
@@ -213,7 +213,7 @@ class IPLDResolver {
213
213
* @param {Iterable.<Object>} nodes - Deserialized IPLD nodes that should be inserted.
214
214
* @param {number} format - The multicodec of the format that IPLD Node should be encoded in.
215
215
* @param {Object} [userOptions] - Options are applied to any of the `nodes` and is an object with the following properties.
216
-
* @param {number} [userOtions.hashAlg=hash algorithm of the given multicodec] - The hashing algorithm that is used to calculate the CID.
216
+
* @param {number} [userOptions.hashAlg=hash algorithm of the given multicodec] - The hashing algorithm that is used to calculate the CID.
217
217
* @param {number} [userOptions.cidVersion=1] - The CID version to use.
218
218
* @param {boolean} [userOptions.onlyHash=false] - If true the serialized form of the IPLD Node will not be passed to the underlying block store.
219
219
* @param {AbortSignal} [userOptions.signal] - A signal that can be used to abort any long-lived operations that are started as a result of this operation.
@@ -262,7 +262,7 @@ class IPLDResolver {
262
262
* @param {CID} cid - The CID of the IPLD Node that should be removed.
263
263
* @param {Object} [options] - Options is an object with the following properties.
264
264
* @param {AbortSignal} [options.signal] - A signal that can be used to abort any long-lived operations that are started as a result of this operation.
265
-
* @return {Promise.<CID>} The CID of the removed IPLD Node.
265
+
* @returns {Promise.<CID>} The CID of the removed IPLD Node.
* @param {number} [userOptions.recursive=false] - whether to get the paths recursively or not. `false` resolves only the paths of the given CID.
304
304
* @param {AbortSignal} [userOptions.signal] - A signal that can be used to abort any long-lived operations that are started as a result of this operation.
305
-
* @returns {Iterable.<Promise.<String>>} - Returns an async iterator with paths that can be resolved into
305
+
* @returns {Iterable.<Promise.<string>>} - Returns an async iterator with paths that can be resolved into
0 commit comments