Interface Link<Data, Format, Alg, V>

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

Template: T

Logical type of the data being linked to.

Template: C

multicodec code corresponding to a codec linked data is encoded with

Template: A

multicodec code corresponding to the hashing algorithm of the CID

interface Link<
    Data extends unknown = unknown,
    Format extends number = number,
    Alg extends number = number,
    V extends Version = 1,
> {
    "[Marker]"?: Data;
    byteLength: number;
    byteOffset: number;
    bytes: ByteView<Link<Data, Format, Alg, V>>;
    code: Format;
    multihash: MultihashDigest<Alg>;
    version: V;
    equals(other: unknown): other is Link<Data, Format, Alg, Version>;
    link(): Link<Data, Format, Alg, V>;
    toString<Prefix extends string>(
        base?: MultibaseEncoder<Prefix>,
    ): ToString<Link<Data, Format, Alg, Version>, Prefix>;
    toV1(): Link<Data, Format, Alg, 1>;
}

Type Parameters

Data extends unknown = unknown
Format extends number = number
Alg extends number = number
V extends Version = 1
CID version

Hierarchy (View Summary)

Phantom<Data>
- Link
  - LegacyLink

Implemented by

CID

Index

Properties

[Marker]? byteLength byteOffset bytes code multihash version

Methods

equals link toString toV1

Properties

`Optional`[Marker]

"[Marker]"?: Data

`Readonly`byteLength

byteLength: number

`Readonly`byteOffset

byteOffset: number

`Readonly`bytes

bytes: ByteView<Link<Data, Format, Alg, V>>

`Readonly`code

code: Format

`Readonly`multihash

multihash: MultihashDigest<Alg>

`Readonly`version

version: V

Methods

equals

equals(other: unknown): other is Link<Data, Format, Alg, Version>
Parameters
- other: unknown
Returns other is Link<Data, Format, Alg, Version>
- Defined in src/link/interface.ts:33

link

link(): Link<Data, Format, Alg, V>
Returns Link<Data, Format, Alg, V>
- Defined in src/link/interface.ts:36

toString

toString<Prefix extends string>(
base?: MultibaseEncoder<Prefix>,
): ToString<Link<Data, Format, Alg, Version>, Prefix>
Returns a string representation of an object.
Type Parameters
- Prefix extends string
Parameters
- Optionalbase: MultibaseEncoder<Prefix>
Returns ToString<Link<Data, Format, Alg, Version>, Prefix>
- Defined in src/link/interface.ts:35

toV1

toV1(): Link<Data, Format, Alg, 1>
Returns Link<Data, Format, Alg, 1>
- Defined in src/link/interface.ts:38