Skip to main content

Data

@iota/audit-trails API documentation

Class: Data

Audit-trail record payload.

Remarks​

Holds either a UTF-8 string or a raw byte sequence. Use Data.fromString or Data.fromBytes to construct an instance, and Data.toString or Data.toBytes to extract the payload as the desired representation.

Properties​

value​

readonly value: any

Returns the underlying payload in its original representation.

Returns​

A string for text payloads or a Uint8Array for byte payloads.

Methods​

toJSON()​

toJSON(): Object

  • Return copy of self without private attributes.

Returns​

Object

toString()​

Call Signature​

toString(): string

Return stringified version of self.

Returns​

string

Call Signature​

toString(): string

Returns the payload as a string.

Returns​

string

A string view of the payload.

Remarks​

Byte payloads are decoded with lossy UTF-8 conversion (invalid sequences become the U+FFFD replacement character).

fromBytes()​

static fromBytes(data): Data

Creates a binary payload.

Parameters​

data​

Uint8Array

Raw bytes to wrap.

Returns​

Data

A Data carrying data as bytes.

fromString()​

static fromString(data): Data

Creates a text payload.

Parameters​

data​

string

UTF-8 string to wrap.

Returns​

Data

A Data carrying data as text.

toBytes()​

toBytes(): Uint8Array

Returns the payload as raw bytes.

Returns​

Uint8Array

A byte view of the payload.

Remarks​

Text payloads are encoded as UTF-8.