Class UcFormatted

Opaque charge formatted data.

This representation is used when formatted data is not recognized by parser.

Hierarchy

UcFormatted

Index

Constructors

Accessors

[toStringTag] data format

Methods

Constructors

constructor

new UcFormatted(format, data): UcFormatted
Constructs unrecognized formatted data.
Parameters
- format: string
  
  Format name.
- data: string | readonly UcToken[]
  
  Either formatted data tokens, or raw string to split onto tokens.
Returns UcFormatted
- Defined in ucnot/churi/src/schema/entity/uc-formatted.ts:23

Accessors

[toStringTag]

get [toStringTag](): string
Returns string
- Defined in ucnot/churi/src/schema/entity/uc-formatted.ts:42

data

get data(): readonly UcToken[]
Formatted data tokens.

Returns readonly UcToken[]
- Defined in ucnot/churi/src/schema/entity/uc-formatted.ts:38

format

get format(): string
Format name.

Returns string
- Defined in ucnot/churi/src/schema/entity/uc-formatted.ts:31

Methods

toString

toString(): string
Represents this formatted data as string.

Returns string
The encoded formatted data.
- Defined in ucnot/churi/src/schema/entity/uc-formatted.ts:62

toUC

toUC(rx, mode): void
Represents this formatted data as charge and transfers it to the given charge receiver.
Parameters
- rx: AllUcrx
  
  Charge receiver.
- mode: UctxMode
  
  Transfer mode.
Returns void
- Defined in ucnot/churi/src/schema/entity/uc-formatted.ts:52

Generated using TypeDoc