Class CID<Data, Format, Alg, Version>

Implements

Type Parameters

Data extends unknown = unknown
Format extends number = number
Alg extends number = number
Version extends Version = Version

Hierarchy

Implements

Link<Data, Format, Alg, Version>

Index

Constructors

constructor

new CID<Data, Format, Alg, Version>(version: Version, code: Format, multihash: MultihashDigest<Alg>, bytes: Uint8Array): "/home/runner/work/w3up-client/w3up-client/node_modules/multiformats/dist/types/src/index".CID<Data, Format, Alg, Version>
Type Parameters
- Data extends unknown = unknown
- Format extends number = number
- Alg extends number = number
- Version extends Version = Version
Parameters
- 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 "/home/runner/work/w3up-client/w3up-client/node_modules/multiformats/dist/types/src/index".CID<Data, Format, Alg, Version>
- Defined in node_modules/multiformats/dist/types/src/cid.d.ts:150

Properties

`Readonly` /

/: Uint8Array

`Readonly` bytes

bytes: Uint8Array

`Readonly` code

code: Format

`Readonly` multihash

multihash: MultihashDigest<Alg>

`Readonly` version

version: Version

Accessors

[toStringTag]

get [toStringTag](): string
Returns string
- Defined in node_modules/multiformats/dist/types/src/cid.d.ts:194

asCID

get asCID(): "/home/runner/work/w3up-client/w3up-client/node_modules/multiformats/dist/types/src/index".CID<Data, Format, Alg, Version>
Signalling cid.asCID === cid has been replaced with cid['/'] === cid.bytes please either use CID.asCID(cid) or switch to new signalling mechanism

Deprecated

Returns "/home/runner/work/w3up-client/w3up-client/node_modules/multiformats/dist/types/src/index".CID<Data, Format, Alg, Version>
- Defined in node_modules/multiformats/dist/types/src/cid.d.ts:167

byteLength

get byteLength(): number
Returns number
Implementation of Link.byteLength
- Defined in node_modules/multiformats/dist/types/src/cid.d.ts:169

byteOffset

get byteOffset(): number
Returns number
Implementation of Link.byteOffset
- Defined in node_modules/multiformats/dist/types/src/cid.d.ts:168

Methods

equals

equals(other: unknown): other is "/home/runner/work/w3up-client/w3up-client/node_modules/multiformats/dist/types/src/index".CID<Data, Format, Alg, Version>
Returns
Parameters
- other: unknown
Returns other is "/home/runner/work/w3up-client/w3up-client/node_modules/multiformats/dist/types/src/index".CID<Data, Format, Alg, Version>
Implementation of API.Link.equals
- Defined in node_modules/multiformats/dist/types/src/cid.d.ts:182

link

link(): "/home/runner/work/w3up-client/w3up-client/node_modules/multiformats/dist/types/src/index".CID<Data, Format, Alg, Version>
Returns "/home/runner/work/w3up-client/w3up-client/node_modules/multiformats/dist/types/src/index".CID<Data, Format, Alg, Version>
Implementation of API.Link.link
- Defined in node_modules/multiformats/dist/types/src/cid.d.ts:193

toJSON

toJSON(): {
    code: Format;
    hash: Uint8Array;
    version: Version;
}
Returns {
    code: Format;
    hash: Uint8Array;
    version: Version;
}
- code: Format
- hash: Uint8Array
- version: Version
Implementation of API.Link.toJSON
- Defined in node_modules/multiformats/dist/types/src/cid.d.ts:188

toString

toString(base?: MultibaseEncoder<string>): string
Returns
Parameters
- Optional base: MultibaseEncoder<string>
Returns string
Implementation of API.Link.toString
- Defined in node_modules/multiformats/dist/types/src/cid.d.ts:187

toV0

toV0(): "/home/runner/work/w3up-client/w3up-client/node_modules/multiformats/dist/types/src/index".CID<Data, 112, 18, 0>
Returns

Returns "/home/runner/work/w3up-client/w3up-client/node_modules/multiformats/dist/types/src/index".CID<Data, 112, 18, 0>
- Defined in node_modules/multiformats/dist/types/src/cid.d.ts:173

toV1

toV1(): "/home/runner/work/w3up-client/w3up-client/node_modules/multiformats/dist/types/src/index".CID<Data, Format, Alg, 1>
Returns

Returns "/home/runner/work/w3up-client/w3up-client/node_modules/multiformats/dist/types/src/index".CID<Data, Format, Alg, 1>
Implementation of API.Link.toV1
- Defined in node_modules/multiformats/dist/types/src/cid.d.ts:177

`Static` asCID

asCID<Data_2, Format_2, Alg_2, Version_2, U>(input: U | Link<Data_2, Format_2, Alg_2, Version_2>): null | "/home/runner/work/w3up-client/w3up-client/node_modules/multiformats/dist/types/src/index".CID<Data_2, Format_2, Alg_2, Version_2>
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 returs null.

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

Returns
Type Parameters
- Data_2 extends unknown
- Format_2 extends number
- Alg_2 extends number
- Version_2 extends Version
- U extends unknown
Parameters
- input: U | Link<Data_2, Format_2, Alg_2, Version_2>
Returns null | "/home/runner/work/w3up-client/w3up-client/node_modules/multiformats/dist/types/src/index".CID<Data_2, Format_2, Alg_2, Version_2>
- Defined in node_modules/multiformats/dist/types/src/cid.d.ts:39

`Static` create

create<Data_3, Format_3, Alg_3, Version_3>(version: Version_3, code: Format_3, digest: MultihashDigest<Alg_3>): "/home/runner/work/w3up-client/w3up-client/node_modules/multiformats/dist/types/src/index".CID<Data_3, Format_3, Alg_3, Version_3>
Returns
Type Parameters
- Data_3 extends unknown
- Format_3 extends number
- Alg_3 extends number
- Version_3 extends Version
Parameters
- version: Version_3
  
  Version of the CID
- code: Format_3
  
  Code of the codec content is encoded in, see https://github.com/multiformats/multicodec/blob/master/table.csv
- digest: MultihashDigest<Alg_3>
  
  (Multi)hash of the of the content.
Returns "/home/runner/work/w3up-client/w3up-client/node_modules/multiformats/dist/types/src/index".CID<Data_3, Format_3, Alg_3, Version_3>
- Defined in node_modules/multiformats/dist/types/src/cid.d.ts:51

`Static` createV0

createV0<T>(digest: MultihashDigest<18>): "/home/runner/work/w3up-client/w3up-client/node_modules/multiformats/dist/types/src/index".CID<T, 112, 18, 0>
Simplified version of create for CIDv0.

Returns
Type Parameters
- T extends unknown = unknown
Parameters
- digest: MultihashDigest<18>
  
  Multihash.
Returns "/home/runner/work/w3up-client/w3up-client/node_modules/multiformats/dist/types/src/index".CID<T, 112, 18, 0>
- Defined in node_modules/multiformats/dist/types/src/cid.d.ts:59

`Static` createV1

createV1<Data_4, Code, Alg_4>(code: Code, digest: MultihashDigest<Alg_4>): "/home/runner/work/w3up-client/w3up-client/node_modules/multiformats/dist/types/src/index".CID<Data_4, Code, Alg_4, 1>
Simplified version of create for CIDv1.

Returns
Type Parameters
- Data_4 extends unknown
- Code extends number
- Alg_4 extends number
Parameters
- code: Code
  
  Content encoding format code.
- digest: MultihashDigest<Alg_4>
  
  Miltihash of the content.
Returns "/home/runner/work/w3up-client/w3up-client/node_modules/multiformats/dist/types/src/index".CID<Data_4, Code, Alg_4, 1>
- Defined in node_modules/multiformats/dist/types/src/cid.d.ts:70

`Static` decode

decode<Data_5, Code_1, Alg_5, Ver>(bytes: ByteView<Link<Data_5, Code_1, Alg_5, Ver>>): "/home/runner/work/w3up-client/w3up-client/node_modules/multiformats/dist/types/src/index".CID<Data_5, Code_1, Alg_5, Ver>
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.

Returns
Type Parameters
- Data_5 extends unknown
- Code_1 extends number
- Alg_5 extends number
- Ver extends Version
Parameters
- bytes: ByteView<Link<Data_5, Code_1, Alg_5, Ver>>
Returns "/home/runner/work/w3up-client/w3up-client/node_modules/multiformats/dist/types/src/index".CID<Data_5, Code_1, Alg_5, Ver>
- Defined in node_modules/multiformats/dist/types/src/cid.d.ts:85

`Static` decodeFirst

decodeFirst<T_1, C, A, V>(bytes: ByteView<Link<T_1, C, A, V>>): ["/home/runner/work/w3up-client/w3up-client/node_modules/multiformats/dist/types/src/index".CID<T_1, C, A, V>, Uint8Array]
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.

Returns
Type Parameters
- T_1 extends unknown
- C extends number
- A extends number
- V extends Version
Parameters
- bytes: ByteView<Link<T_1, C, A, V>>
Returns ["/home/runner/work/w3up-client/w3up-client/node_modules/multiformats/dist/types/src/index".CID<T_1, C, A, V>, Uint8Array]
- Defined in node_modules/multiformats/dist/types/src/cid.d.ts:102

`Static` equals

equals<Data_1, Format_1, Alg_1, Version_1>(self: Link<Data_1, Format_1, Alg_1, Version_1>, other: unknown): other is "/home/runner/work/w3up-client/w3up-client/node_modules/multiformats/dist/types/src/index".CID<any, number, number, Version>
Returns
Type Parameters
- Data_1 extends unknown
- Format_1 extends number
- Alg_1 extends number
- Version_1 extends Version
Parameters
- self: Link<Data_1, Format_1, Alg_1, Version_1>
- other: unknown
Returns other is "/home/runner/work/w3up-client/w3up-client/node_modules/multiformats/dist/types/src/index".CID<any, number, number, Version>
- Defined in node_modules/multiformats/dist/types/src/cid.d.ts:20

`Static` inspectBytes

inspectBytes<T_2, C_1, A_1, V_1>(initialBytes: ByteView<Link<T_2, C_1, A_1, V_1>>): {
    codec: C_1;
    digestSize: number;
    multihashCode: A_1;
    multihashSize: number;
    size: number;
    version: V_1;
}
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.

Returns
Type Parameters
- T_2 extends unknown
- C_1 extends number
- A_1 extends number
- V_1 extends Version
Parameters
- initialBytes: ByteView<Link<T_2, C_1, A_1, V_1>>
Returns {
    codec: C_1;
    digestSize: number;
    multihashCode: A_1;
    multihashSize: number;
    size: number;
    version: V_1;
}
- codec: C_1
- digestSize: number
- multihashCode: A_1
- multihashSize: number
- size: number
- version: V_1
- Defined in node_modules/multiformats/dist/types/src/cid.d.ts:119

`Static` parse

parse<Prefix, Data_6, Code_2, Alg_6, Ver_1>(source: ToString<Link<Data_6, Code_2, Alg_6, Ver_1>, Prefix>, base?: "/home/runner/work/w3up-client/w3up-client/node_modules/@ucanto/interface/dist/src/lib".MultibaseDecoder<Prefix>): "/home/runner/work/w3up-client/w3up-client/node_modules/multiformats/dist/types/src/index".CID<Data_6, Code_2, Alg_6, Ver_1>
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).

Returns
Type Parameters
- Prefix extends string
- Data_6 extends unknown
- Code_2 extends number
- Alg_6 extends number
- Ver_1 extends Version
Parameters
- source: ToString<Link<Data_6, Code_2, Alg_6, Ver_1>, Prefix>
- Optional base: "/home/runner/work/w3up-client/w3up-client/node_modules/@ucanto/interface/dist/src/lib".MultibaseDecoder<Prefix>
Returns "/home/runner/work/w3up-client/w3up-client/node_modules/multiformats/dist/types/src/index".CID<Data_6, Code_2, Alg_6, Ver_1>
- Defined in node_modules/multiformats/dist/types/src/cid.d.ts:142

Class CID<Data, Format, Alg, Version>

Implements

Type Parameters

Data extends unknown = unknown

Format extends number = number

Alg extends number = number

Version extends Version = Version

Hierarchy

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Type Parameters

Data extends unknown = unknown

Format extends number = number

Alg extends number = number

Version extends Version = Version

Parameters

version: Version

code: Format

multihash: MultihashDigest<Alg>

bytes: Uint8Array

Returns "/home/runner/work/w3up-client/w3up-client/node_modules/multiformats/dist/types/src/index".CID<Data, Format, Alg, Version>

Properties

Readonly /

Readonly bytes

Readonly code

Readonly multihash

Readonly version

Accessors

[toStringTag]

Returns string

asCID

Deprecated

Returns "/home/runner/work/w3up-client/w3up-client/node_modules/multiformats/dist/types/src/index".CID<Data, Format, Alg, Version>

byteLength

Returns number

byteOffset

Returns number

Methods

equals

Returns

Parameters

other: unknown

Returns other is "/home/runner/work/w3up-client/w3up-client/node_modules/multiformats/dist/types/src/index".CID<Data, Format, Alg, Version>

link

Returns "/home/runner/work/w3up-client/w3up-client/node_modules/multiformats/dist/types/src/index".CID<Data, Format, Alg, Version>

toJSON

Returns { code: Format; hash: Uint8Array; version: Version; }

code: Format

hash: Uint8Array

version: Version

toString

Returns

Parameters

Optional base: MultibaseEncoder<string>

Returns string

toV0

Returns

Returns "/home/runner/work/w3up-client/w3up-client/node_modules/multiformats/dist/types/src/index".CID<Data, 112, 18, 0>

toV1

Returns

Returns "/home/runner/work/w3up-client/w3up-client/node_modules/multiformats/dist/types/src/index".CID<Data, Format, Alg, 1>

Static asCID

Returns

Type Parameters

Data_2 extends unknown

Format_2 extends number

Alg_2 extends number

Version_2 extends Version

U extends unknown

Parameters

input: U | Link<Data_2, Format_2, Alg_2, Version_2>

Returns null | "/home/runner/work/w3up-client/w3up-client/node_modules/multiformats/dist/types/src/index".CID<Data_2, Format_2, Alg_2, Version_2>

Static create

Returns

`Readonly` /

`Readonly` bytes

`Readonly` code

`Readonly` multihash

`Readonly` version

Returns {
code: Format;
hash: Uint8Array;
version: Version;
}

`Optional` base: MultibaseEncoder<string>

`Static` asCID

`Static` create

`Static` createV0

`Static` createV1

`Static` decode

`Static` decodeFirst

`Static` equals

`Static` inspectBytes

Returns {
codec: C_1;
digestSize: number;
multihashCode: A_1;
multihashSize: number;
size: number;
version: V_1;
}