FixedArray
Algorand TypeScript / index / FixedArray
Defined in: arrays.ts:9
A fixed sized array
Type Parameters
Section titled “Type Parameters”TItem
The type of a single item in the array
TLength
Section titled “TLength”TLength extends number
The fixed length of the array
Implements
Section titled “Implements”ConcatArray<TItem>
Indexable
Section titled “Indexable”[index: uint64]: TItem
Get or set the item at the specified index. Negative indexes are not supported
Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new FixedArray<
TItem,TLength>():FixedArray<TItem,TLength>
Defined in: arrays.ts:13
Create a new FixedArray instance
Returns
Section titled “Returns”FixedArray<TItem, TLength>
Constructor
Section titled “Constructor”new FixedArray<
TItem,TLength>(…items):FixedArray<TItem,TLength>
Defined in: arrays.ts:18
Create a new FixedArray instance with the specified items
Parameters
Section titled “Parameters”…TItem[] & object
The initial items for the array
Returns
Section titled “Returns”FixedArray<TItem, TLength>
Accessors
Section titled “Accessors”length
Section titled “length”Get Signature
Section titled “Get Signature”get length():
uint64
Defined in: arrays.ts:32
Returns the statically declared length of this array
Returns
Section titled “Returns”Implementation of
Section titled “Implementation of”ConcatArray.length
Methods
Section titled “Methods”[iterator]()
Section titled “[iterator]()”[iterator]():
IterableIterator<TItem>
Defined in: arrays.ts:69
Returns an iterator for the items in this array
Returns
Section titled “Returns”IterableIterator<TItem>
at(
index):TItem
Defined in: arrays.ts:41
Returns the item at the given index. Negative indexes are taken from the end.
Parameters
Section titled “Parameters”The index of the item to retrieve
Returns
Section titled “Returns”TItem
concat()
Section titled “concat()”concat(…
items):TItem[]
Defined in: arrays.ts:25
Returns a new array containing all items from this array, and other array
Parameters
Section titled “Parameters”…(TItem | ConcatArray<TItem>)[]
Another array to concat with this one
Returns
Section titled “Returns”TItem[]
entries()
Section titled “entries()”entries():
ArrayIterator<readonly [uint64,TItem]>
Defined in: arrays.ts:76
Returns an iterator for a tuple of the indexes and items in this array
Returns
Section titled “Returns”ArrayIterator<readonly [uint64, TItem]>
join()
Section titled “join()”join(
separator?):string
Defined in: arrays.ts:99
Creates a string by concatenating all the items in the array delimited by the specified separator (or ’,’ by default)
Parameters
Section titled “Parameters”separator?
Section titled “separator?”string
Returns
Section titled “Returns”string
Deprecated
Section titled “Deprecated”Join is not supported in Algorand TypeScript
Implementation of
Section titled “Implementation of”ConcatArray.join
keys()
Section titled “keys()”keys():
IterableIterator<uint64>
Defined in: arrays.ts:83
Returns an iterator for the indexes in this array
Returns
Section titled “Returns”IterableIterator<uint64>
slice()
Section titled “slice()”Call Signature
Section titled “Call Signature”slice():
TItem[]
Defined in: arrays.ts:48
Returns
Section titled “Returns”TItem[]
Deprecated
Section titled “Deprecated”Array slicing is not yet supported in Algorand TypeScript Create a new Dynamic array with all items from this array
Implementation of
Section titled “Implementation of”ConcatArray.slice
Call Signature
Section titled “Call Signature”slice(
end):TItem[]
Defined in: arrays.ts:54
Parameters
Section titled “Parameters”An index in which to stop copying items.
Returns
Section titled “Returns”TItem[]
Deprecated
Section titled “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
Section titled “Implementation of”ConcatArray.slice
Call Signature
Section titled “Call Signature”slice(
start,end):TItem[]
Defined in: arrays.ts:61
Parameters
Section titled “Parameters”An index in which to start copying items.
An index in which to stop copying items
Returns
Section titled “Returns”TItem[]
Deprecated
Section titled “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
Section titled “Implementation of”ConcatArray.slice