Skip to main content

ImmutableMetadata

@iota/notarization API documentation

Class: ImmutableMetadata

The fixed-at-creation metadata of a notarization.

Remarks​

Captures the values that cannot change after the notarization exists: creation timestamp, optional human-readable description, and the optional LockMetadata.

Properties​

createdAt​

readonly createdAt: bigint

The creation timestamp, in milliseconds since the Unix epoch.

description​

readonly description: undefined | string

The optional human-readable description set at creation, if any.

locking​

readonly locking: undefined | LockMetadata

The optional LockMetadata attached at creation.

Remarks​

Presence depends on the Notarization Method:

  • Dynamic: absent when the Dynamic-Notarization carries no transfer lock; present otherwise.
  • Locked: always present.

Returns​

The LockMetadata, or null when none is attached.

Methods​

toJSON()​

toJSON(): Object

  • Return copy of self without private attributes.

Returns​

Object

toString()​

toString(): string

Return stringified version of self.

Returns​

string