Skip to content

feat!: add CIDVersion type #87

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
May 26, 2021
Merged

feat!: add CIDVersion type #87

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 8 additions & 6 deletions src/cid.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ import { coerce } from './bytes.js'

/**
* @typedef {import('./hashes/interface').MultihashDigest} MultihashDigest
* @typedef {0 | 1} CIDVersion
*/

/**
Expand All @@ -20,7 +21,7 @@ import { coerce } from './bytes.js'

export class CID {
/**
* @param {0|1} version
* @param {CIDVersion} version
* @param {number} code
* @param {MultihashDigest} multihash
* @param {Uint8Array} bytes
Expand Down Expand Up @@ -218,7 +219,7 @@ export class CID {

/**
*
* @param {number} version - Version of the CID
* @param {CIDVersion} version - Version of the CID
* @param {number} code - Code of the codec content is encoded in.
* @param {MultihashDigest} digest - (Multi)hash of the of the content.
* @returns {CID}
Expand Down Expand Up @@ -318,7 +319,7 @@ export class CID {
* inspection.
*
* @param {Uint8Array} initialBytes
* @returns {{ version:number, codec:number, multihashCode:number, digestSize:number, multihashSize:number, size:number }}
* @returns {{ version:CIDVersion, codec:number, multihashCode:number, digestSize:number, multihashSize:number, size:number }}
*/
static inspectBytes (initialBytes) {
let offset = 0
Expand All @@ -335,7 +336,9 @@ export class CID {
offset = 0
} else if (version === 1) {
codec = next()
} else if (version !== 1) {
}

if (version !== 0 && version !== 1) {
throw new RangeError(`Invalid CID version ${version}`)
}

Expand Down Expand Up @@ -444,8 +447,7 @@ const DAG_PB_CODE = 0x70
const SHA_256_CODE = 0x12

/**
*
* @param {number} version
* @param {CIDVersion} version
* @param {number} code
* @param {Uint8Array} multihash
* @returns {Uint8Array}
Expand Down