CID

Defined in: node_modules/.pnpm/multiformats@13.4.1/node_modules/multiformats/dist/src/cid.d.ts:6

Represents an IPLD link to a specific data of type T.

Template

Logical type of the data being linked to.

Template

multicodec code corresponding to a codec linked data is encoded with

Template

multicodec code corresponding to the hashing algorithm of the CID

Type Parameters

Type Parameter	Default type	Description
`Data`	`unknown`	-
`Format` extends `number`	`number`	-
`Alg` extends `number`	`number`	-
`Version` extends `Version`	`Version`	CID version

Implements

Link<Data, Format, Alg, Version>

Constructors

Constructor

new CID<Data, Format, Alg, Version>(
   version,
   code,
   multihash,
bytes): CID<Data, Format, Alg, Version>;

Defined in: node_modules/.pnpm/multiformats@13.4.1/node_modules/multiformats/dist/src/cid.d.ts:17

Parameters

Parameter	Type	Description
`version`	`Version`	Version of the CID
`code`	`Format`	Code of the codec content is encoded in, see https://github.com/multiformats/multicodec/blob/master/table.csv
`multihash`	`MultihashDigest`<`Alg`>	(Multi)hash of the of the content.
`bytes`	`Uint8Array`	-

Returns

CID<Data, Format, Alg, Version>

Properties

[toStringTag]

readonly [toStringTag]: "CID" = "CID";

Defined in: node_modules/.pnpm/multiformats@13.4.1/node_modules/multiformats/dist/src/cid.d.ts:34

/

readonly /: Uint8Array;

Defined in: node_modules/.pnpm/multiformats@13.4.1/node_modules/multiformats/dist/src/cid.d.ts:11

bytes

readonly bytes: Uint8Array;

Defined in: node_modules/.pnpm/multiformats@13.4.1/node_modules/multiformats/dist/src/cid.d.ts:10

Implementation of

Link.bytes

code

readonly code: Format;

Defined in: node_modules/.pnpm/multiformats@13.4.1/node_modules/multiformats/dist/src/cid.d.ts:7

Implementation of

Link.code

multihash

readonly multihash: MultihashDigest<Alg>;

Defined in: node_modules/.pnpm/multiformats@13.4.1/node_modules/multiformats/dist/src/cid.d.ts:9

Implementation of

Link.multihash

version

readonly version: Version;

Defined in: node_modules/.pnpm/multiformats@13.4.1/node_modules/multiformats/dist/src/cid.d.ts:8

Implementation of

Link.version

Accessors

asCID

Get Signature

get asCID(): this;

Defined in: node_modules/.pnpm/multiformats@13.4.1/node_modules/multiformats/dist/src/cid.d.ts:24

Signalling cid.asCID === cid has been replaced with cid['/'] === cid.bytes please either use CID.asCID(cid) or switch to new signalling mechanism

Returns

this

byteLength

Get Signature

get byteLength(): number;

Defined in: node_modules/.pnpm/multiformats@13.4.1/node_modules/multiformats/dist/src/cid.d.ts:26

Returns

number

Implementation of

Link.byteLength

byteOffset

Get Signature

get byteOffset(): number;

Defined in: node_modules/.pnpm/multiformats@13.4.1/node_modules/multiformats/dist/src/cid.d.ts:25

Returns

number

Implementation of

Link.byteOffset

Methods

equals()

equals(other): other is CID<Data, Format, Alg, Version>;

Defined in: node_modules/.pnpm/multiformats@13.4.1/node_modules/multiformats/dist/src/cid.d.ts:29

Parameters

Parameter	Type
`other`	`unknown`

Returns

other is CID<Data, Format, Alg, Version>

Implementation of

Link.equals

link()

link(): this;

Defined in: node_modules/.pnpm/multiformats@13.4.1/node_modules/multiformats/dist/src/cid.d.ts:33

Returns

this

Implementation of

Link.link

toJSON()

toJSON(): LinkJSON<CID<Data, Format, Alg, Version>>;

Defined in: node_modules/.pnpm/multiformats@13.4.1/node_modules/multiformats/dist/src/cid.d.ts:32

Returns

LinkJSON<CID<Data, Format, Alg, Version>>

toString()

toString(base?): string;

Defined in: node_modules/.pnpm/multiformats@13.4.1/node_modules/multiformats/dist/src/cid.d.ts:31

Returns a string representation of an object.

Parameters

Parameter	Type
`base?`	`MultibaseEncoder`<`string`>

Returns

string

Implementation of

Link.toString

toV0()

toV0(): CID<Data, 112, 18, 0>;

Defined in: node_modules/.pnpm/multiformats@13.4.1/node_modules/multiformats/dist/src/cid.d.ts:27

Returns

CID<Data, 112, 18, 0>

toV1()

toV1(): CID<Data, Format, Alg, 1>;

Defined in: node_modules/.pnpm/multiformats@13.4.1/node_modules/multiformats/dist/src/cid.d.ts:28

Returns

CID<Data, Format, Alg, 1>

Implementation of

Link.toV1

asCID()

static asCID<Data, Format, Alg, Version, U>(input): null | CID<Data, Format, Alg, Version>;

Defined in: node_modules/.pnpm/multiformats@13.4.1/node_modules/multiformats/dist/src/cid.d.ts:45

Takes any input value and returns a CID instance if it was a CID otherwise returns null. If value is instanceof CID it will return value back. If value is not instance of this CID class, but is compatible CID it will return new instance of this CID class. Otherwise returns null.

This allows two different incompatible versions of CID library to co-exist and interop as long as binary interface is compatible.

Type Parameters

Type Parameter
`Data`
`Format` extends `number`
`Alg` extends `number`
`Version` extends `Version`
`U`

Parameters

Parameter	Type
`input`	\| `U` \| `Link`<`Data`, `Format`, `Alg`, `Version`>

Returns

null | CID<Data, Format, Alg, Version>

create()

static create<Data, Format, Alg, Version>(
   version,
   code,
digest): CID<Data, Format, Alg, Version>;

Defined in: node_modules/.pnpm/multiformats@13.4.1/node_modules/multiformats/dist/src/cid.d.ts:51

Type Parameters

Type Parameter
`Data`
`Format` extends `number`
`Alg` extends `number`
`Version` extends `Version`

Parameters

Parameter	Type	Description
`version`	`Version`	Version of the CID
`code`	`Format`	Code of the codec content is encoded in, see https://github.com/multiformats/multicodec/blob/master/table.csv
`digest`	`MultihashDigest`<`Alg`>	(Multi)hash of the of the content.

Returns

CID<Data, Format, Alg, Version>

createV0()

static createV0<T>(digest): CID<T, 112, 18, 0>;

Defined in: node_modules/.pnpm/multiformats@13.4.1/node_modules/multiformats/dist/src/cid.d.ts:55

Simplified version of create for CIDv0.

Type Parameters

Type Parameter	Default type
`T`	`unknown`

Parameters

Parameter	Type
`digest`	`MultihashDigest`<`18`>

Returns

CID<T, 112, 18, 0>

createV1()

static createV1<Data, Code, Alg>(code, digest): CID<Data, Code, Alg, 1>;

Defined in: node_modules/.pnpm/multiformats@13.4.1/node_modules/multiformats/dist/src/cid.d.ts:62

Simplified version of create for CIDv1.

Type Parameters

Type Parameter
`Data`
`Code` extends `number`
`Alg` extends `number`

Parameters

Parameter	Type	Description
`code`	`Code`	Content encoding format code.
`digest`	`MultihashDigest`<`Alg`>	Multihash of the content.

Returns

CID<Data, Code, Alg, 1>

decode()

static decode<Data, Code, Alg, Version>(bytes): CID<Data, Code, Alg, Version>;

Defined in: node_modules/.pnpm/multiformats@13.4.1/node_modules/multiformats/dist/src/cid.d.ts:70

Decoded a CID from its binary representation. The byte array must contain only the CID with no additional bytes.

An error will be thrown if the bytes provided do not contain a valid binary representation of a CID.

Type Parameters

Type Parameter
`Data`
`Code` extends `number`
`Alg` extends `number`
`Version` extends `Version`

Parameters

Parameter	Type
`bytes`	`ByteView`<`Link`<`Data`, `Code`, `Alg`, `Version`>>

Returns

CID<Data, Code, Alg, Version>

decodeFirst()

static decodeFirst<T, C, A, V>(bytes): [CID<T, C, A, V>, Uint8Array<ArrayBufferLike>];

Defined in: node_modules/.pnpm/multiformats@13.4.1/node_modules/multiformats/dist/src/cid.d.ts:80

Decoded a CID from its binary representation at the beginning of a byte array.

Returns an array with the first element containing the CID and the second element containing the remainder of the original byte array. The remainder will be a zero-length byte array if the provided bytes only contained a binary CID representation.

Type Parameters

Type Parameter
`T`
`C` extends `number`
`A` extends `number`
`V` extends `Version`

Parameters

Parameter	Type
`bytes`	`ByteView`<`Link`<`T`, `C`, `A`, `V`>>

Returns

[CID<T, C, A, V>, Uint8Array<ArrayBufferLike>]

equals()

static equals<Data, Format, Alg, Version>(self, other): other is CID<unknown, number, number, Version>;

Defined in: node_modules/.pnpm/multiformats@13.4.1/node_modules/multiformats/dist/src/cid.d.ts:30

Type Parameters

Type Parameter
`Data`
`Format` extends `number`
`Alg` extends `number`
`Version` extends `Version`

Parameters

Parameter	Type
`self`	`Link`<`Data`, `Format`, `Alg`, `Version`>
`other`	`unknown`

Returns

other is CID<unknown, number, number, Version>

inspectBytes()

static inspectBytes<T, C, A, V>(initialBytes): object;

Defined in: node_modules/.pnpm/multiformats@13.4.1/node_modules/multiformats/dist/src/cid.d.ts:90

Inspect the initial bytes of a CID to determine its properties.

Involves decoding up to 4 varints. Typically this will require only 4 to 6 bytes but for larger multicodec code values and larger multihash digest lengths these varints can be quite large. It is recommended that at least 10 bytes be made available in the initialBytes argument for a complete inspection.

Type Parameters

Type Parameter
`T`
`C` extends `number`
`A` extends `number`
`V` extends `Version`

Parameters

Parameter	Type
`initialBytes`	`ByteView`<`Link`<`T`, `C`, `A`, `V`>>

Returns

object

codec

codec: C;

digestSize

digestSize: number;

multihashCode

multihashCode: A;

multihashSize

multihashSize: number;

size

size: number;

version

version: V;

parse()

static parse<Prefix, Data, Code, Alg, Version>(source, base?): CID<Data, Code, Alg, Version>;

Defined in: node_modules/.pnpm/multiformats@13.4.1/node_modules/multiformats/dist/src/cid.d.ts:104

Takes cid in a string representation and creates an instance. If base decoder is not provided will use a default from the configuration. It will throw an error if encoding of the CID is not compatible with supplied (or a default decoder).

Type Parameters

Type Parameter
`Prefix` extends `string`
`Data`
`Code` extends `number`
`Alg` extends `number`
`Version` extends `Version`

Parameters

Parameter	Type
`source`	`ToString`<`Link`<`Data`, `Code`, `Alg`, `Version`>, `Prefix`>
`base?`	`MultibaseDecoder`<`Prefix`>

Returns

CID<Data, Code, Alg, Version>