Class CLValueOption

Represents an optional value in the Casper type system. An option can either contain a value or be empty (null).

Hierarchy

CLValueOption

Index

Constructors

Properties

Methods

bytes isEmpty toJSON toString value fromBytes

Constructors

constructor

new CLValueOption(inner: null | CLValue, type?: CLTypeOption): CLValueOption
Initializes a new instance of the CLValueOption class.
Parameters
- inner: null | CLValue
  
  The CLValue contained in the option, or null if empty.
- Optional type: CLTypeOption
  
  The CLTypeOption representing the type of the option.
Returns CLValueOption
- Defined in src/types/clvalue/Option.ts:21

Properties

inner

inner: null | CLValue

`Optional` type

type?: CLTypeOption

Methods

bytes

bytes(): Uint8Array
Converts the option to its byte representation. If the option is empty, it returns a Uint8Array with a single 0 byte. If it contains a value, it returns a Uint8Array with 1 followed by the inner value's bytes.

Returns
A Uint8Array representing the bytes of the option.

Returns Uint8Array
- Defined in src/types/clvalue/Option.ts:32

isEmpty

isEmpty(): boolean
Checks if the option is empty.

Returns
true if the option is empty, false otherwise.

Returns boolean
- Defined in src/types/clvalue/Option.ts:64

toJSON

toJSON(): any
Converts the instance to a JSON-compatible format.

Returns
The JSON representation of the inner value or null if empty.

If the instance is empty, it returns null. Otherwise, it calls toJSON() on the inner value to produce its JSON representation.

Returns any
- Defined in src/types/clvalue/Option.ts:56

toString

toString(): string
Provides a string representation of the option.

Returns
An empty string if the option is empty, otherwise the string representation of the inner value.

Returns string
- Defined in src/types/clvalue/Option.ts:44

value

value(): null | CLValue
Retrieves the inner value of the option.

Returns
The inner CLValue if the option is not empty, or null if it is empty.

Returns null | CLValue
- Defined in src/types/clvalue/Option.ts:72

`Static` fromBytes

fromBytes(source: Uint8Array, clType: CLTypeOption): IResultWithBytes<CLValueOption>
Creates a CLValueOption instance from a Uint8Array. Parses the byte array to determine if the option is empty or contains a value.

Returns
An object containing the new CLValueOption instance and any remaining bytes.
Parameters
- source: Uint8Array
  
  The Uint8Array containing the byte representation of the Option value.
- clType: CLTypeOption
  
  The CLTypeOption representing the type of the option.
Returns IResultWithBytes<CLValueOption>
- Defined in src/types/clvalue/Option.ts:83

Generated using TypeDoc