Skip to main content

ImmutableMetadata

@iota/audit-trails API documentation

Class: ImmutableMetadata

Immutable trail metadata.

Remarks​

Stored once on the trail object at creation and exposed read-only thereafter. Use OnChainAuditTrail.updatableMetadata for the mutable counterpart.

Properties​

name​

name: string

Human-readable trail name.

Accessors​

description​

Get Signature​

get description(): string | undefined

Optional human-readable description.

Returns​

string | undefined

Set Signature​

set description(value): void

Optional human-readable description.

Parameters​
value​

string | null | undefined

Returns​

void

Methods​

toJSON()​

toJSON(): Object

  • Return copy of self without private attributes.

Returns​

Object

toString()​

toString(): string

Return stringified version of self.

Returns​

string