Class Revision

A representation of a IPNS record that may be initial or revised.

Index

Constructors

Accessors

name sequence ttl validity value

Methods

Constructors

constructor

new Revision(
    name: Name,
    value: string,
    sequence: bigint,
    validity: string,
    options?: RevisionOptions,
): Revision
Parameters
- name: Name
- value: string
- sequence: bigint
- validity: string
- Optionaloptions: RevisionOptions
Returns Revision
- Defined in index.ts:233

Accessors

name

get name(): Name
Returns Name
- Defined in index.ts:258

sequence

get sequence(): bigint
Returns bigint
- Defined in index.ts:266

ttl

get ttl(): undefined | bigint
TTL in nanoseconds

Returns undefined | bigint
- Defined in index.ts:278

validity

get validity(): string
RFC3339 date string.

Returns string
- Defined in index.ts:273

value

get value(): string
Returns string
- Defined in index.ts:262

Methods

`Static`decode

decode(bytes: Uint8Array): Revision
Decodes a Revision from a binary representation.
Parameters
- bytes: Uint8Array
  a Uint8Array containing a binary encoding of a Revision, as produced by #encode.
Returns Revision
a Revision object

Throws
if bytes does not contain a valid encoded Revision
- Defined in index.ts:305

`Static`encode

encode(revision: Revision): Uint8Array
Encodes a Revision to a binary representation and returns it as a Uint8Array.

Note: if revision.name is a WritableName then signing key data will be lost. i.e. the private key is not encoded.
Parameters
- revision: Revision
Returns Uint8Array
- Defined in index.ts:288