Class CID

template Prefix

Hierarchy

CID

Index

Constructors

constructor

Properties

Accessors

Methods

Constructors

constructor

new CID(version: CIDVersion, code: number, multihash: MultihashDigest<number>, bytes: Uint8Array): CID

- Defined in node_modules/multiformats/types/src/cid.d.ts:115
Parameters
- version: CIDVersion
- code: number
- multihash: MultihashDigest<number>
- bytes: Uint8Array
Returns CID

Properties

byteLength

byteLength: number

byteOffset

byteOffset: number

bytes

bytes: Uint8Array

code

code: number

multihash

multihash: MultihashDigest<number>

version

version: CIDVersion

Accessors

[toStringTag]

get [toStringTag](): string

- Defined in node_modules/multiformats/types/src/cid.d.ts:156
Returns string

buffer

get buffer(): void

- Defined in node_modules/multiformats/types/src/cid.d.ts:153
Returns void

codec

get codec(): void

- Defined in node_modules/multiformats/types/src/cid.d.ts:152
Returns void

multibaseName

get multibaseName(): void

- Defined in node_modules/multiformats/types/src/cid.d.ts:154
Returns void

prefix

get prefix(): void

- Defined in node_modules/multiformats/types/src/cid.d.ts:155
Returns void

toBaseEncodedString

get toBaseEncodedString(): void

- Defined in node_modules/multiformats/types/src/cid.d.ts:151
Returns void

Methods

equals

equals(other: any): any

- Defined in node_modules/multiformats/types/src/cid.d.ts:140
Parameters
- other: any
Returns any

toJSON

toJSON(): { code: number; hash: Uint8Array; version: CIDVersion }

- Defined in node_modules/multiformats/types/src/cid.d.ts:146
Returns { code: number; hash: Uint8Array; version: CIDVersion }
- code: number
- hash: Uint8Array
- version: CIDVersion

toString

toString(base?: MultibaseEncoder<any>): string

- Defined in node_modules/multiformats/types/src/cid.d.ts:145
Parameters
- Optional base: MultibaseEncoder<any>
Returns string

toV0

toV0(): CID

- Defined in node_modules/multiformats/types/src/cid.d.ts:132
Returns CID

toV1

toV1(): CID

- Defined in node_modules/multiformats/types/src/cid.d.ts:136
Returns CID

Static asCID

asCID(value: any): null | CID

- Defined in node_modules/multiformats/types/src/cid.d.ts:31
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.

Parameters
- value: any
Returns null | CID

Static create

create(version: CIDVersion, code: number, digest: MultihashDigest<number>): CID

- Defined in node_modules/multiformats/types/src/cid.d.ts:39
Parameters
- version: CIDVersion
  
  Version of the CID
- code: number
  
  Code of the codec content is encoded in.
- digest: MultihashDigest<number>
  
  (Multi)hash of the of the content.
Returns CID

Static createV0

createV0(digest: MultihashDigest<number>): CID

- Defined in node_modules/multiformats/types/src/cid.d.ts:44
Simplified version of create for CIDv0.

Parameters
- digest: MultihashDigest<number>
  
  Multihash.
Returns CID

Static createV1

createV1<Code>(code: Code, digest: MultihashDigest<number>): CID

- Defined in node_modules/multiformats/types/src/cid.d.ts:52
Simplified version of create for CIDv1.

Type parameters
- Code: number
Parameters
- code: Code
  
  Content encoding format code.
- digest: MultihashDigest<number>
  
  Miltihash of the content.
Returns CID

Static decode

decode(bytes: Uint8Array): CID

- Defined in node_modules/multiformats/types/src/cid.d.ts:63
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.

Parameters
- bytes: Uint8Array
Returns CID

Static decodeFirst

decodeFirst(bytes: Uint8Array): [CID, Uint8Array]

- Defined in node_modules/multiformats/types/src/cid.d.ts:76
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.

Parameters
- bytes: Uint8Array
Returns [CID, Uint8Array]

Static inspectBytes

inspectBytes(initialBytes: Uint8Array): { codec: number; digestSize: number; multihashCode: number; multihashSize: number; size: number; version: CIDVersion }

- Defined in node_modules/multiformats/types/src/cid.d.ts:89
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.

Parameters
- initialBytes: Uint8Array
Returns { codec: number; digestSize: number; multihashCode: number; multihashSize: number; size: number; version: CIDVersion }
- codec: number
- digestSize: number
- multihashCode: number
- multihashSize: number
- size: number
- version: CIDVersion

Static isCID

isCID(value: any): value is CID

- Defined in node_modules/multiformats/types/src/cid.d.ts:18
Parameters
- value: any
Returns value is CID

Static parse

parse<Prefix>(source: string, base?: MultibaseDecoder<Prefix>): CID

- Defined in node_modules/multiformats/types/src/cid.d.ts:107
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
- Prefix: string
Parameters
- source: string
- Optional base: MultibaseDecoder<Prefix>
Returns CID

Generated using TypeDoc