Class Cid

Utility class for creating CIDs. Exported for the convenience of developers.

Index

Constructors

Methods

computeCid computeDagPbCidFromBytes computeDagPbCidFromStream parseCid

Constructors

constructor

new Cid(): Cid
Returns Cid

Methods

`Static`computeCid

computeCid(payload, codecCode?, multihashCode?): Promise<string>
Computes a V1 CID for the provided payload
Parameters
- payload: any
- codecCode: number = cbor.code
  the codec to use. Defaults to cbor
- multihashCode: number = sha256.code
  the multihasher to use. Defaults to sha256
Returns Promise<string>
payload CID

Throws
codec is not supported

Throws
encoding fails

Throws
if hasher is not supported
- Defined in src/utils/cid.ts:37

`Static`computeDagPbCidFromBytes

computeDagPbCidFromBytes(content): Promise<string>
Parameters
- content: Uint8Array
Returns Promise<string>
V1 CID of the DAG comprised by chunking data into unixfs DAG-PB encoded blocks
- Defined in src/utils/cid.ts:79

`Static`computeDagPbCidFromStream

computeDagPbCidFromStream(dataStream): Promise<string>
Parameters
- dataStream: Readable
Returns Promise<string>
V1 CID of the DAG comprised by chunking data into unixfs DAG-PB encoded blocks
- Defined in src/utils/cid.ts:92

`Static`parseCid

parseCid(str): CID<unknown, number, number, Version>
Parses the given CID string into a {CID}.
Parameters
- str: string
Returns CID<unknown, number, number, Version>
- Defined in src/utils/cid.ts:62