ArrayIterator

@algorandfoundation/algorand-typescript

@algorandfoundation/algorand-typescript / index / <internal> / ArrayIterator

Interface: ArrayIterator<T>

Defined in: node_modules/typescript/lib/lib.es2015.iterable.d.ts:72

Extends

IteratorObject<T, BuiltinIteratorReturn, unknown>

Type Parameters

• T

Properties

[toStringTag]

readonly [toStringTag]: string

Defined in: node_modules/typescript/lib/lib.esnext.iterator.d.ts:134

Inherited from

IteratorObject.[toStringTag]

Methods

[dispose]()

Call Signature

[dispose](): void

Defined in: node_modules/typescript/lib/lib.esnext.disposable.d.ts:36

Returns

void

Inherited from

IteratorObject.[dispose]

Call Signature

[dispose](): void

Defined in: node_modules/@types/node/compatibility/disposable.d.ts:11

Returns

void

Inherited from

IteratorObject.[dispose]

[iterator]()

[iterator](): ArrayIterator<T>

Defined in: node_modules/typescript/lib/lib.es2015.iterable.d.ts:73

Returns

ArrayIterator<T>

Overrides

IteratorObject.[iterator]

drop()

drop(count): IteratorObject<T, undefined, unknown>

Defined in: node_modules/typescript/lib/lib.esnext.iterator.d.ts:74

Creates an iterator whose values are the values from this iterator after skipping the provided count.

Parameters

count

number

The number of values to drop.

Returns

IteratorObject<T, undefined, unknown>

Inherited from

IteratorObject.drop

every()

every(predicate): boolean

Defined in: node_modules/typescript/lib/lib.esnext.iterator.d.ts:122

Determines whether all the members of this iterator satisfy the specified test.

Parameters

predicate

(value, index) => unknown

A function that accepts up to two arguments. The every method calls the predicate function for each element in this iterator until the predicate returns false, or until the end of this iterator.

Returns

boolean

Inherited from

IteratorObject.every

filter()

Call Signature

filter<S>(predicate): IteratorObject<S, undefined, unknown>

Defined in: node_modules/typescript/lib/lib.esnext.iterator.d.ts:56

Creates an iterator whose values are those from this iterator for which the provided predicate returns true.

Type Parameters

• S

Parameters

predicate

(value, index) => value is S

A function that accepts up to two arguments to be used to test values from the underlying iterator.

Returns

IteratorObject<S, undefined, unknown>

Inherited from

IteratorObject.filter

Call Signature

filter(predicate): IteratorObject<T, undefined, unknown>

Defined in: node_modules/typescript/lib/lib.esnext.iterator.d.ts:62

Creates an iterator whose values are those from this iterator for which the provided predicate returns true.

Parameters

predicate

(value, index) => unknown

A function that accepts up to two arguments to be used to test values from the underlying iterator.

Returns

IteratorObject<T, undefined, unknown>

Inherited from

IteratorObject.filter

find()

Call Signature

find<S>(predicate): undefined | S

Defined in: node_modules/typescript/lib/lib.esnext.iterator.d.ts:131

Returns the value of the first element in this iterator where predicate is true, and undefined otherwise.

Type Parameters

• S

Parameters

predicate

(value, index) => value is S

find calls predicate once for each element of this iterator, in order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.

Returns

undefined | S

Inherited from

IteratorObject.find

Call Signature

find(predicate): undefined | T

Defined in: node_modules/typescript/lib/lib.esnext.iterator.d.ts:132

Parameters

predicate

(value, index) => unknown

Returns

undefined | T

Inherited from

IteratorObject.find

flatMap()

flatMap<U>(callback): IteratorObject<U, undefined, unknown>

Defined in: node_modules/typescript/lib/lib.esnext.iterator.d.ts:80

Creates an iterator whose values are the result of applying the callback to the values from this iterator and then flattening the resulting iterators or iterables.

Type Parameters

• U

Parameters

callback

(value, index) => Iterator<U, unknown, undefined> | Iterable<U, unknown, undefined>

A function that accepts up to two arguments to be used to transform values from the underlying iterator into new iterators or iterables to be flattened into the result.

Returns

IteratorObject<U, undefined, unknown>

Inherited from

IteratorObject.flatMap

forEach()

forEach(callbackfn): void

Defined in: node_modules/typescript/lib/lib.esnext.iterator.d.ts:106

Performs the specified action for each element in the iterator.

Parameters

callbackfn

(value, index) => void

A function that accepts up to two arguments. forEach calls the callbackfn function one time for each element in the iterator.

Returns

void

Inherited from

IteratorObject.forEach

map()

map<U>(callbackfn): IteratorObject<U, undefined, unknown>

Defined in: node_modules/typescript/lib/lib.esnext.iterator.d.ts:50

Creates an iterator whose values are the result of applying the callback to the values from this iterator.

Type Parameters

• U

Parameters

callbackfn

(value, index) => U

A function that accepts up to two arguments to be used to transform values from the underlying iterator.

Returns

IteratorObject<U, undefined, unknown>

Inherited from

IteratorObject.map

next()

next(…__namedParameters): IteratorResult<T, undefined>

Defined in: node_modules/typescript/lib/lib.es2015.iterable.d.ts:43

Parameters

__namedParameters

[] | [unknown]

Returns

IteratorResult<T, undefined>

Inherited from

IteratorObject.next

reduce()

Call Signature

reduce(callbackfn): T

Defined in: node_modules/typescript/lib/lib.esnext.iterator.d.ts:87

Calls the specified callback function for all the elements in this iterator. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

Parameters

callbackfn

(previousValue, currentValue, currentIndex) => T

A function that accepts up to three arguments. The reduce method calls the callbackfn function one time for each element in the iterator.

Returns

T

Inherited from

IteratorObject.reduce

Call Signature

reduce(callbackfn, initialValue): T

Defined in: node_modules/typescript/lib/lib.esnext.iterator.d.ts:88

Parameters

callbackfn

(previousValue, currentValue, currentIndex) => T

initialValue

T

Returns

T

Inherited from

IteratorObject.reduce

Call Signature

reduce<U>(callbackfn, initialValue): U

Defined in: node_modules/typescript/lib/lib.esnext.iterator.d.ts:95

Type Parameters

• U

Parameters

callbackfn

(previousValue, currentValue, currentIndex) => U

A function that accepts up to three arguments. The reduce method calls the callbackfn function one time for each element in the iterator.

initialValue

U

If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of a value from the iterator.

Returns

U

Inherited from

IteratorObject.reduce

return()?

optional return(value?): IteratorResult<T, undefined>

Defined in: node_modules/typescript/lib/lib.es2015.iterable.d.ts:44

Parameters

value?

undefined

Returns

IteratorResult<T, undefined>

Inherited from

IteratorObject.return

some()

some(predicate): boolean

Defined in: node_modules/typescript/lib/lib.esnext.iterator.d.ts:114

Determines whether the specified callback function returns true for any element of this iterator.

Parameters

predicate

(value, index) => unknown

A function that accepts up to two arguments. The some method calls the predicate function for each element in this iterator until the predicate returns a value true, or until the end of the iterator.

Returns

boolean

Inherited from

IteratorObject.some

take()

take(limit): IteratorObject<T, undefined, unknown>

Defined in: node_modules/typescript/lib/lib.esnext.iterator.d.ts:68

Creates an iterator whose values are the values from this iterator, stopping once the provided limit is reached.

Parameters

limit

number

The maximum number of values to yield.

Returns

IteratorObject<T, undefined, unknown>

Inherited from

IteratorObject.take

throw()?

optional throw(e?): IteratorResult<T, undefined>

Defined in: node_modules/typescript/lib/lib.es2015.iterable.d.ts:45

Parameters

e?

any

Returns

IteratorResult<T, undefined>

Inherited from

IteratorObject.throw

toArray()

toArray(): T[]

Defined in: node_modules/typescript/lib/lib.esnext.iterator.d.ts:100

Creates a new array from the values yielded by this iterator.

Returns

T[]

Inherited from

IteratorObject.toArray