Class DataBlob

Representation of a transfer's memo or a registerData transaction's data, which enforces that:

the byte length is <= 256

Hierarchy

DataBlob

Index

Constructors

Properties

__type data fromTypedJSON

Methods

toJSON toString toTypedJSON fromJSON

Constructors

constructor

new DataBlob(data: ArrayBuffer): DataBlob
Parameters
- data: ArrayBuffer
Returns DataBlob
- Defined in packages/sdk/src/types/DataBlob.ts:22

Properties

`Private` __type

__type: TypedJsonDiscriminator = JSON_DISCRIMINATOR

Having a private field prevents similar structured objects to be considered the same type (similar to nominal typing).

`Readonly` data

data: Buffer

`Static` fromTypedJSON

fromTypedJSON: ((json: TypedJson<string>) => string | DataBlob) = ...

Type declaration

- (json: TypedJson<string>): string | DataBlob
- Takes a TypedJson object and converts it to instance of type DataBlob.
  
  Throws
  - If unexpected JSON string is passed.
  Returns
  The parsed instance.
  Parameters
  - json: TypedJson<string>
    
    The typed JSON to convert.
  Returns string | DataBlob

Methods

toJSON

toJSON(): string
Encodes the data to a JSON-serializable hex-string.

Returns
The hex-string representation of the data.

Returns string
- Defined in packages/sdk/src/types/DataBlob.ts:35

toString

toString(): string
Get a string representation of the data blob in hex format.

Returns
The string representation.

Returns string
- Defined in packages/sdk/src/types/DataBlob.ts:43

toTypedJSON

toTypedJSON(): TypedJson<string>
Takes an Type and transforms it to a TypedJson format.

Returns
The transformed object.

Returns TypedJson<string>
- Defined in packages/sdk/src/types/DataBlob.ts:64

`Static` fromJSON

fromJSON(value: string): DataBlob
Takes a hex-string and converts it to an instance of type DataBlob. The method expects the string to be prefixed with a 2-byte length like the one returned by toJSON.

Returns
The parsed instance.
Parameters
- value: string
  
  Hex-string to be converted to a DataBlob.
Returns DataBlob
- Defined in packages/sdk/src/types/DataBlob.ts:54

Generated using TypeDoc