Interface UCANLink<C, Encoding, SigAlg>

Represents an IPLD link to a UCAN in either IPLD or JWT format

Template

Type Parameters

C extends Capabilities = Capabilities
Encoding extends MulticodecCode = MulticodecCode
multicodec code corresponding to the encoding
SigAlg extends SigAlg = SigAlg
multicodec code corresponding to the hashing algorithm of the CID

Hierarchy

Link<UCAN.UCAN<C>, Encoding, SigAlg>
- UCANLink

Index

Properties

[Marker]? byteLength byteOffset bytes code equals link multihash toString toV1 version

Properties

`Optional` [Marker]

[Marker]?: UCAN.UCAN<C>

`Readonly` byteLength

byteLength: number

`Readonly` byteOffset

byteOffset: number

`Readonly` bytes

bytes: ByteView<Link<UCAN.UCAN<C>, Encoding, SigAlg, 1>>

`Readonly` code

code: Encoding

equals

equals: ((other) => other is Link<UCAN.UCAN<C>, Encoding, SigAlg, UCAN.LinkVersion>)

Type declaration

- (other): other is Link<UCAN.UCAN<C>, Encoding, SigAlg, UCAN.LinkVersion>
- Parameters
  - other: unknown
  Returns other is Link<UCAN.UCAN<C>, Encoding, SigAlg, UCAN.LinkVersion>

link

link: (() => Link<UCAN.UCAN<C>, Encoding, SigAlg, 1>)

Type declaration

- (): Link<UCAN.UCAN<C>, Encoding, SigAlg, 1>
- Returns Link<UCAN.UCAN<C>, Encoding, SigAlg, 1>

`Readonly` multihash

multihash: MultihashDigest<SigAlg>

toString

toString: (<Prefix>(base?) => ToString<Link<UCAN.UCAN<C>, Encoding, SigAlg, UCAN.LinkVersion>, Prefix>)

Type declaration

- <Prefix>(base?): ToString<Link<UCAN.UCAN<C>, Encoding, SigAlg, UCAN.LinkVersion>, Prefix>
- Type Parameters
  - Prefix extends string
  Parameters
  - Optional base: MultibaseEncoder<Prefix>
  Returns ToString<Link<UCAN.UCAN<C>, Encoding, SigAlg, UCAN.LinkVersion>, Prefix>

toV1

toV1: (() => Link<UCAN.UCAN<C>, Encoding, SigAlg, 1>)

Type declaration

- (): Link<UCAN.UCAN<C>, Encoding, SigAlg, 1>
- Returns Link<UCAN.UCAN<C>, Encoding, SigAlg, 1>

`Readonly` version

version: 1

Generated using TypeDoc