Class FixedArray<TItem, TLength>

A fixed sized array

Type Parameters

TItem
The type of a single item in the array
TLength extends number
The fixed length of the array

Implements

ConcatArray<TItem>

Indexable

[index: uint64]: TItem
Get or set the item at the specified index. Negative indexes are not supported

Index

Constructors

constructor

new FixedArray<TItem, TLength extends number>(): FixedArray<TItem, TLength>
Create a new FixedArray instance
Type Parameters
- TItem
- TLength extends number
Returns FixedArray<TItem, TLength>
- Defined in arrays.ts:13
new FixedArray<TItem, TLength extends number>(
...items: TItem[] & { length: TLength },
): FixedArray<TItem, TLength>
Create a new FixedArray instance with the specified items
Type Parameters
- TItem
- TLength extends number
Parameters
- ...items: TItem[] & { length: TLength }
  The initial items for the array
Returns FixedArray<TItem, TLength>
- Defined in arrays.ts:18

Accessors

length

get length(): uint64
Returns the statically declared length of this array

Returns uint64
Implementation of ConcatArray.length
- Defined in arrays.ts:32

Methods

[iterator]

"[iterator]"(): IterableIterator<TItem>
Returns an iterator for the items in this array

Returns IterableIterator<TItem>
- Defined in arrays.ts:69

at

at(index: Uint64Compat): TItem
Returns the item at the given index. Negative indexes are taken from the end.
Parameters
- index: Uint64Compat
  The index of the item to retrieve
Returns TItem
- Defined in arrays.ts:41

concat

concat(...items: (TItem | ConcatArray<TItem>)[]): TItem[]
Returns a new array containing all items from this array, and other array
Parameters
- ...items: (TItem | ConcatArray<TItem>)[]
  Another array to concat with this one
Returns TItem[]
- Defined in arrays.ts:25

entries

entries(): ArrayIterator<readonly [uint64, TItem]>
Returns an iterator for a tuple of the indexes and items in this array

Returns ArrayIterator<readonly [uint64, TItem]>
- Defined in arrays.ts:76

join

join(separator?: string): string
Creates a string by concatenating all the items in the array delimited by the specified separator (or ',' by default)
Parameters
- Optionalseparator: string
Returns string
Deprecated
Join is not supported in Algorand TypeScript
Implementation of ConcatArray.join
- Defined in arrays.ts:99

keys

keys(): IterableIterator<uint64>
Returns an iterator for the indexes in this array

Returns IterableIterator<uint64>
- Defined in arrays.ts:83

slice

slice(): TItem[]
Returns TItem[]
Deprecated
Array slicing is not yet supported in Algorand TypeScript Create a new Dynamic array with all items from this array
Implementation of ConcatArray.slice
- Defined in arrays.ts:48
slice(end: Uint64Compat): TItem[]
Parameters
- end: Uint64Compat
  An index in which to stop copying items.
Returns TItem[]
Deprecated
Array slicing is not yet supported in Algorand TypeScript Create a new DynamicArray with all items up till end. Negative indexes are taken from the end.
Implementation of ConcatArray.slice
- Defined in arrays.ts:54
slice(start: Uint64Compat, end: Uint64Compat): TItem[]
Parameters
- start: Uint64Compat
  An index in which to start copying items.
- end: Uint64Compat
  An index in which to stop copying items
Returns TItem[]
Deprecated
Array slicing is not yet supported in Algorand TypeScript Create a new DynamicArray with items from start, up until end Negative indexes are taken from the end.
Implementation of ConcatArray.slice
- Defined in arrays.ts:61

Class FixedArray<TItem, TLength>

Type Parameters

Implements

Indexable

Index

Constructors

Accessors

Methods

Constructors

constructor

Type Parameters

Returns FixedArray<TItem, TLength>

Type Parameters

Parameters

Returns FixedArray<TItem, TLength>

Accessors

length

Returns uint64

Methods

[iterator]

Returns IterableIterator<TItem>

at

Parameters

Returns TItem

concat

Parameters

Returns TItem[]

entries

Returns ArrayIterator<readonly [uint64, TItem]>

join

Parameters

Returns string

Deprecated

keys

Returns IterableIterator<uint64>

slice

Returns TItem[]

Deprecated

Parameters

Returns TItem[]

Deprecated

Parameters

Returns TItem[]

Deprecated

Settings

On This Page