Skip to content

Commit adec0c4

Browse files
authored
docs: update tsdoc for CID code param to clarify "what kind of code?" (#181)
Motivation: * 'code' isn't very helpful to a beginner because it has many possible definitions
1 parent b2951dc commit adec0c4

File tree

1 file changed

+1
-1
lines changed

1 file changed

+1
-1
lines changed

src/cid.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ import { coerce } from './bytes.js'
2222
export class CID {
2323
/**
2424
* @param {CIDVersion} version
25-
* @param {number} code
25+
* @param {number} code - multicodec code, see https://github.com/multiformats/multicodec/blob/master/table.csv
2626
* @param {MultihashDigest} multihash
2727
* @param {Uint8Array} bytes
2828
*

0 commit comments

Comments
 (0)