Class CLValueList

Represents a List value in the Casper type system. This class provides methods to manage and manipulate lists of CLValues.

Hierarchy

CLValueList

Index

Constructors

Properties

Methods

append bytes get isEmpty pop remove set size toJSON toString fromBytes

Constructors

constructor

new CLValueList(type: CLTypeList, elements?: CLValue[]): CLValueList
Initializes a new instance of the CLValueList class.
Parameters
- type: CLTypeList
  
  The CLTypeList representing the type of the list.
- elements: CLValue[] = []
  
  Optional array of CLValues to initialize the list with.
Returns CLValueList
- Defined in src/types/clvalue/List.ts:29

Properties

elements

elements: CLValue[]

The elements contained in the list.

type

type: CLTypeList

The type of the list elements.

Methods

append

append(value: CLValue): void
Appends a new element to the list.
Parameters
- value: CLValue
  
  The CLValue to append to the list.
Returns void
- Defined in src/types/clvalue/List.ts:65

bytes

bytes(): Uint8Array
Converts the list to its byte representation, including the length and each element's bytes.

Returns
A Uint8Array representing the bytes of the list.

Returns Uint8Array
- Defined in src/types/clvalue/List.ts:38

get

get(index: number): CLValue
Gets the element at the specified index.

Returns
The CLValue at the specified index.

Throws
Error if the index is out of bounds.
Parameters
- index: number
  
  The index of the element to get.
Returns CLValue
- Defined in src/types/clvalue/List.ts:112

isEmpty

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

Returns
true if the list is empty, false otherwise.

Returns boolean
- Defined in src/types/clvalue/List.ts:57

pop

pop(): undefined | CLValue
Removes and returns the last element from the list.

Returns
The last element of the list, or undefined if the list is empty.

Returns undefined | CLValue
- Defined in src/types/clvalue/List.ts:81

remove

remove(index: number): void
Removes an element from the list at the specified index.
Parameters
- index: number
  
  The index of the element to remove.
Returns void
- Defined in src/types/clvalue/List.ts:73

set

set(index: number, item: CLValue): void
Sets the element at the specified index.

Throws
Error if the index is out of bounds.
Parameters
- index: number
  
  The index at which to set the element.
- item: CLValue
  
  The CLValue to set at the specified index.
Returns void
- Defined in src/types/clvalue/List.ts:99

size

size(): number
Returns the number of elements in the list.

Returns
The number of elements in the list.

Returns number
- Defined in src/types/clvalue/List.ts:89

toJSON

toJSON(): string[]
Converts the list to a JSON-compatible representation.

Returns
An array of string representations of the list elements.

Returns string[]
- Defined in src/types/clvalue/List.ts:123

toString

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

Returns
A string in the format "[elem1, elem2, ...]".

Returns string
- Defined in src/types/clvalue/List.ts:48

`Static` fromBytes

fromBytes(source: Uint8Array, clType: CLTypeList): IResultWithBytes<CLValueList>
Creates a CLValueList instance from a Uint8Array. Parses the byte array to interpret the length of the list and each element in the list.

Returns
An object containing the new CLValueList instance and any remaining bytes.
Parameters
- source: Uint8Array
  
  The Uint8Array containing the byte representation of the List value.
- clType: CLTypeList
  
  The CLTypeList representing the type of the list.
Returns IResultWithBytes<CLValueList>
- Defined in src/types/clvalue/List.ts:134

Generated using TypeDoc