Class Txt

Represents a text string encoded according the Normalization Form Canonical Composition Unicode Equivalence.

Implements

Hierarchy (view full)

String
- Txt
  - Revision

Implements

VeChainDataModel<Txt>

Index

Constructors

Accessors

Methods

compareTo isEqual toString of

Constructors

`Protected`constructor

new Txt(exp): Txt
Protected
Creates a new instance of this class representing the exp string normalized according the Canonical Composition Form Unicode Equivalence.
Parameters
- exp: string
  The expression to be passed to the constructor.
Returns Txt
Overrides String.constructor
- Defined in packages/core/src/vcdm/Txt.ts:45

Accessors

bi

get bi(): bigint
Converts the current Txt string to a BigInt.

Returns bigint
The BigInt representation of the Txt string.

Throws
If the conversion to BigInt fails because this Txt string doesn't represent an integer.
Implementation of VeChainDataModel.bi
- Defined in packages/core/src/vcdm/Txt.ts:56

bytes

get bytes(): Uint8Array
Converts the current Txt string to a buffer of bytes.

Returns Uint8Array
The bytes representation of the Txt string.
Implementation of VeChainDataModel.bytes
- Defined in packages/core/src/vcdm/Txt.ts:74

n

get n(): number
Converts the current Txt string to a number.

Returns number
The numeric value of the Txt string.

Throws
If the conversion to number fails because this Txt string doesn't represent a decimal number.
Implementation of VeChainDataModel.n
- Defined in packages/core/src/vcdm/Txt.ts:90

Methods

compareTo

compareTo(that): number
Compares the current instance to another instance of Txt.
Parameters
- that: Txt
  The instance to compare with.
Returns number
- A negative number if the current instance is less than the specified instance, zero if they are equal, or a positive number if the current instance is greater.
Implementation of VeChainDataModel.compareTo
- Defined in packages/core/src/vcdm/Txt.ts:102

isEqual

isEqual(that): boolean
Checks if the current Txt object is equal to the given Txt object.
Parameters
- that: Txt
  The Txt object to compare with.
Returns boolean
- True if the objects are equal, false otherwise.
Implementation of VeChainDataModel.isEqual
- Defined in packages/core/src/vcdm/Txt.ts:113

toString

toString(): string
Returns a string representation of the object.

Returns string
A string representation of the object.
Overrides String.toString
- Defined in packages/core/src/vcdm/Txt.ts:122

`Static`of

of(exp): Txt
Creates a new Txt instance from the provided expression.
Parameters
- exp:
      | string
      | number
      | bigint
      | Uint8Array
  The expression to convert to Txt:
  - bigint is represented as a NFC encoded string expressing the value in base 10;
  - number is represented as a NFC encoded string expressing the value in base 10;
  - string is encoded as NFC string;
  - Uint8Array is NFC decoded to a string.
Returns Txt
- A new Txt instance.
- Defined in packages/core/src/vcdm/Txt.ts:137