Skip to content
This repository was archived by the owner on Aug 11, 2021. It is now read-only.

Commit 10c3777

Browse files
achingbrainvmx
authored andcommitted
chore: update deps
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)
1 parent 0200768 commit 10c3777

2 files changed

Lines changed: 11 additions & 11 deletions

File tree

package.json

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -34,14 +34,14 @@
3434
"license": "MIT",
3535
"devDependencies": {
3636
"abort-controller": "^3.0.0",
37-
"aegir": "^25.0.0",
37+
"aegir": "^28.1.0",
3838
"bitcoinjs-lib": "^5.1.6",
39-
"buffer": "^5.6.0",
39+
"buffer": "^6.0.1",
4040
"ethereumjs-block": "^2.2.0",
4141
"ipld-bitcoin": "^0.4.0",
4242
"ipld-ethereum": "^5.0.0",
4343
"ipld-git": "^0.6.1",
44-
"ipld-in-memory": "^6.0.0",
44+
"ipld-in-memory": "^7.0.0",
4545
"ipld-zcash": "^0.5.0",
4646
"merkle-patricia-tree": "^3.0.0",
4747
"multihashes": "^3.0.1",
@@ -50,7 +50,7 @@
5050
},
5151
"dependencies": {
5252
"cids": "^1.0.0",
53-
"ipld-block": "^0.10.0",
53+
"ipld-block": "^0.11.0",
5454
"ipld-dag-cbor": "^0.17.0",
5555
"ipld-dag-pb": "^0.20.0",
5656
"ipld-raw": "^6.0.0",

src/index.js

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -78,8 +78,8 @@ class IPLDResolver {
7878
* @param {Object} [options] - Options is an object with the following properties.
7979
* @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.
8080
* @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.
8383
*/
8484
resolve (cid, path, options) {
8585
if (!CID.isCID(cid)) {
@@ -169,7 +169,7 @@ class IPLDResolver {
169169
* @param {Object} node - The deserialized IPLD node that should be inserted.
170170
* @param {number} format - The multicodec of the format that IPLD Node should be encoded in.
171171
* @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.
173173
* @param {number} [userOptions.cidVersion=1] - The CID version to use.
174174
* @param {boolean} [userOptions.onlyHash=false] - If true the serialized form of the IPLD Node will not be passed to the underlying block store.
175175
* @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 {
213213
* @param {Iterable.<Object>} nodes - Deserialized IPLD nodes that should be inserted.
214214
* @param {number} format - The multicodec of the format that IPLD Node should be encoded in.
215215
* @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.
217217
* @param {number} [userOptions.cidVersion=1] - The CID version to use.
218218
* @param {boolean} [userOptions.onlyHash=false] - If true the serialized form of the IPLD Node will not be passed to the underlying block store.
219219
* @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 {
262262
* @param {CID} cid - The CID of the IPLD Node that should be removed.
263263
* @param {Object} [options] - Options is an object with the following properties.
264264
* @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.
266266
*/
267267
async remove (cid, options) { // eslint-disable-line require-await
268268
return this.bs.delete(cid, options)
@@ -277,7 +277,7 @@ class IPLDResolver {
277277
* @param {Iterable.<CID>} cids - The CIDs of the IPLD Nodes that should be removed.
278278
* @param {Object} [options] - Options is an object with the following properties.
279279
* @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.
280-
* @return {Iterable.<Promise.<CID>>} Returns an async iterator with the CIDs of the removed IPLD Nodes.
280+
* @returns {Iterable.<Promise.<CID>>} Returns an async iterator with the CIDs of the removed IPLD Nodes.
281281
*/
282282
removeMany (cids, options) {
283283
if (!typical.isIterable(cids) || typeof cids === 'string' ||
@@ -302,7 +302,7 @@ class IPLDResolver {
302302
* @param {Object} [userOptions]
303303
* @param {number} [userOptions.recursive=false] - whether to get the paths recursively or not. `false` resolves only the paths of the given CID.
304304
* @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
306306
*/
307307
tree (cid, offsetPath, userOptions) {
308308
if (typeof offsetPath === 'object') {

0 commit comments

Comments
 (0)