Interface IAsyncParallel<TSource>

Common Methods between IAsyncEnumerable and IParallelEnumerable

interface IAsyncParallel<TSource> {
    "[asyncIterator]"(): AsyncIterableIterator<TSource>;
    aggregate(func: (x: TSource, y: TSource) => TSource): Promise<TSource>;
    aggregate<TAccumulate>(
        seed: TAccumulate,
        func: (x: TAccumulate, y: TSource) => TAccumulate,
    ): Promise<TAccumulate>;
    aggregate<TAccumulate, TResult>(
        seed: TAccumulate,
        func: (x: TAccumulate, y: TSource) => TAccumulate,
        resultSelector: (x: TAccumulate) => TResult,
    ): Promise<TResult>;
    all(predicate: (x: TSource) => boolean): Promise<boolean>;
    allAsync(predicate: (x: TSource) => Promise<boolean>): Promise<boolean>;
    any(predicate?: (x: TSource) => boolean): Promise<boolean>;
    anyAsync(predicate: (x: TSource) => Promise<boolean>): Promise<boolean>;
    average(this: IAsyncParallel<number>): Promise<number>;
    average(selector: (x: TSource) => number): Promise<number>;
    averageAsync(selector: (x: TSource) => Promise<number>): Promise<number>;
    contains(
        value: TSource,
        comparer?: IEqualityComparer<TSource>,
    ): Promise<boolean>;
    containsAsync(
        value: TSource,
        comparer: IAsyncEqualityComparer<TSource>,
    ): Promise<boolean>;
    count(predicate?: (x: TSource) => boolean): Promise<number>;
    countAsync(predicate: (x: TSource) => Promise<boolean>): Promise<number>;
    elementAt(index: number): Promise<TSource>;
    elementAtOrDefault(index: number): Promise<null | TSource>;
    first(predicate?: (x: TSource) => boolean): Promise<TSource>;
    firstAsync(predicate: (x: TSource) => Promise<boolean>): Promise<TSource>;
    firstOrDefault(
        predicate?: (x: TSource) => boolean,
    ): Promise<null | TSource>;
    firstOrDefaultAsync(
        predicate: (x: TSource) => Promise<boolean>,
    ): Promise<null | TSource>;
    last(predicate?: (x: TSource) => boolean): Promise<TSource>;
    lastAsync(predicate: (x: TSource) => Promise<boolean>): Promise<TSource>;
    lastOrDefault(predicate?: (x: TSource) => boolean): Promise<null | TSource>;
    lastOrDefaultAsync(
        predicate: (x: TSource) => Promise<boolean>,
    ): Promise<null | TSource>;
    max(this: IAsyncParallel<number>): Promise<number>;
    max(selector: (x: TSource) => number): Promise<number>;
    maxAsync(selector: (x: TSource) => Promise<number>): Promise<number>;
    min(this: IAsyncParallel<number>): Promise<number>;
    min(selector: (x: TSource) => number): Promise<number>;
    minAsync(selector: (x: TSource) => Promise<number>): Promise<number>;
    partition(
        predicate: (x: TSource) => boolean,
    ): Promise<[pass: TSource[], fail: TSource[]]>;
    partitionAsync(
        predicate: (x: TSource) => Promise<boolean>,
    ): Promise<[pass: TSource[], fail: TSource[]]>;
    single(predicate?: (x: TSource) => boolean): Promise<TSource>;
    singleAsync(predicate: (x: TSource) => Promise<boolean>): Promise<TSource>;
    singleOrDefault(
        predicate?: (x: TSource) => boolean,
    ): Promise<null | TSource>;
    singleOrDefaultAsync(
        predicate: (x: TSource) => Promise<boolean>,
    ): Promise<null | TSource>;
    sum(this: IAsyncParallel<number>): Promise<number>;
    sum(selector: (x: TSource) => number): Promise<number>;
    sumAsync(selector: (x: TSource) => Promise<number>): Promise<number>;
    toArray(): Promise<TSource[]>;
    toMap<TKey>(selector: (x: TSource) => TKey): Promise<Map<TKey, TSource[]>>;
    toMapAsync<TKey>(
        selector: (x: TSource) => Promise<TKey>,
    ): Promise<Map<TKey, TSource[]>>;
    toObject<TKey extends string | number | symbol>(
        selector: (x: TSource) => TKey,
    ): Promise<Record<TKey, TSource>>;
    toObjectAsync<TKey extends string | number | symbol>(
        selector: (x: TSource) => Promise<TKey>,
    ): Promise<Record<TKey, TSource>>;
    toSet(): Promise<Set<TSource>>;
}

Type Parameters

TSource

Hierarchy (View Summary)

AsyncIterable<TSource>
- IAsyncParallel
  - IAsyncEnumerable
  - IParallelEnumerable

Methods

[asyncIterator]

"[asyncIterator]"(): AsyncIterableIterator<TSource>
Returns AsyncIterableIterator<TSource>
Overrides AsyncIterable.[asyncIterator]
- Defined in src/types/IAsyncParallel.ts:292

aggregate

aggregate(func: (x: TSource, y: TSource) => TSource): Promise<TSource>
Applies an accumulator function over a sequence.
Parameters
- func: (x: TSource, y: TSource) => TSource
  An accumulator function to be invoked on each element.
Returns Promise<TSource>
The final accumulator value.
- Defined in src/types/IAsyncParallel.ts:12
aggregate<TAccumulate>(
seed: TAccumulate,
func: (x: TAccumulate, y: TSource) => TAccumulate,
): Promise<TAccumulate>
Applies an accumulator function over a sequence. The specified seed value is used as the initial accumulator value.
Type Parameters
- TAccumulate
Parameters
- seed: TAccumulate
  The initial accumulator value.
- func: (x: TAccumulate, y: TSource) => TAccumulate
  An accumulator function to be invoked on each element.
Returns Promise<TAccumulate>
The final accumulator value.
- Defined in src/types/IAsyncParallel.ts:20
aggregate<TAccumulate, TResult>(
    seed: TAccumulate,
    func: (x: TAccumulate, y: TSource) => TAccumulate,
    resultSelector: (x: TAccumulate) => TResult,
): Promise<TResult>
Applies an accumulator function over a sequence. The specified seed value is used as the initial accumulator value, and the specified function is used to select the result value.
Type Parameters
- TAccumulate
- TResult
Parameters
- seed: TAccumulate
  The initial accumulator value.
- func: (x: TAccumulate, y: TSource) => TAccumulate
  An accumulator function to be invoked on each element.
- resultSelector: (x: TAccumulate) => TResult
  A function to transform the final accumulator value into the result value.
Returns Promise<TResult>
The transformed final accumulator value.
- Defined in src/types/IAsyncParallel.ts:30

all

all(predicate: (x: TSource) => boolean): Promise<boolean>
Determines whether all elements of a sequence satisfy a condition.
Parameters
- predicate: (x: TSource) => boolean
  A function to test each element for a condition.
Returns Promise<boolean>
true if every element of the source sequence passes the test in the specified predicate, or if the sequence is empty; otherwise, false.
- Defined in src/types/IAsyncParallel.ts:40

allAsync

allAsync(predicate: (x: TSource) => Promise<boolean>): Promise<boolean>
Determines whether all elements of a sequence satisfy a condition.
Parameters
- predicate: (x: TSource) => Promise<boolean>
  An async function to test each element for a condition.
Returns Promise<boolean>
true if every element of the source sequence passes the test in the specified predicate, or if the sequence is empty; otherwise, false.
- Defined in src/types/IAsyncParallel.ts:47

any

any(predicate?: (x: TSource) => boolean): Promise<boolean>
Determines whether a sequence contains any elements. If predicate is specified, determines whether any element of a sequence satisfies a condition.
Parameters
- Optionalpredicate: (x: TSource) => boolean
  A function to test each element for a condition.
Returns Promise<boolean>
true if the source sequence contains any elements or passes the test specified; otherwise, false.
- Defined in src/types/IAsyncParallel.ts:54

anyAsync

anyAsync(predicate: (x: TSource) => Promise<boolean>): Promise<boolean>
Determines whether any element of a sequence satisfies a condition.
Parameters
- predicate: (x: TSource) => Promise<boolean>
  An async function to test each element for a condition.
Returns Promise<boolean>
true if the source sequence contains any elements or passes the test specified; otherwise, false.
- Defined in src/types/IAsyncParallel.ts:60

average

average(this: IAsyncParallel<number>): Promise<number>
Computes the average of a sequence of number values.
Parameters
- this: IAsyncParallel<number>
Returns Promise<number>
The average of the sequence of values.

Throws
source contains no elements.
- Defined in src/types/IAsyncParallel.ts:66
average(selector: (x: TSource) => number): Promise<number>
Computes the average of a sequence of values that are obtained by invoking a transform function on each element of the input sequence.
Parameters
- selector: (x: TSource) => number
  A transform function to apply to each element.
Returns Promise<number>
The average of the sequence of values.

Throws
source contains no elements.
- Defined in src/types/IAsyncParallel.ts:74

averageAsync

averageAsync(selector: (x: TSource) => Promise<number>): Promise<number>
Computes the average of a sequence of values that are obtained by invoking a transform function on each element of the input sequence.
Parameters
- selector: (x: TSource) => Promise<number>
  An async transform function to apply to each element.
Returns Promise<number>
The average of the sequence of values.

Throws
source contains no elements.
- Defined in src/types/IAsyncParallel.ts:82

contains

contains(
value: TSource,
comparer?: IEqualityComparer<TSource>,
): Promise<boolean>
Determines whether a sequence contains a specified element by using the specified or default IEqualityComparer.
Parameters
- value: TSource
  The value to locate in the sequence.
- Optionalcomparer: IEqualityComparer<TSource>
  An equality comparer to compare values. Optional.
Returns Promise<boolean>
true if the source sequence contains an element that has the specified value; otherwise, false.
- Defined in src/types/IAsyncParallel.ts:90

containsAsync

containsAsync(
value: TSource,
comparer: IAsyncEqualityComparer<TSource>,
): Promise<boolean>
Determines whether a sequence contains a specified element by using the specified or default IEqualityComparer.
Parameters
- value: TSource
  The value to locate in the sequence.
- comparer: IAsyncEqualityComparer<TSource>
  An async equality comparer to compare values.
Returns Promise<boolean>
true if the source sequence contains an element that has the specified value; otherwise, false.
- Defined in src/types/IAsyncParallel.ts:98

count

count(predicate?: (x: TSource) => boolean): Promise<number>
Returns the number of elements in a sequence or represents how many elements in the specified sequence satisfy a condition if the predicate is specified.
Parameters
- Optionalpredicate: (x: TSource) => boolean
  A function to test each element for a condition. Optional.
Returns Promise<number>
The number of elements in the input sequence.
- Defined in src/types/IAsyncParallel.ts:106

countAsync

countAsync(predicate: (x: TSource) => Promise<boolean>): Promise<number>
Returns the number of elements in a sequence or represents how many elements in the specified sequence satisfy a condition if the predicate is specified.
Parameters
- predicate: (x: TSource) => Promise<boolean>
  A function to test each element for a condition.
Returns Promise<number>
The number of elements in the input sequence.
- Defined in src/types/IAsyncParallel.ts:114

elementAt

elementAt(index: number): Promise<TSource>
Returns the element at a specified index in a sequence.
Parameters
- index: number
  The zero-based index of the element to retrieve.
Returns Promise<TSource>
The element at the specified position in the source sequence.

Throws
index is less than 0 or greater than or equal to the number of elements in source.
- Defined in src/types/IAsyncParallel.ts:122

elementAtOrDefault

elementAtOrDefault(index: number): Promise<null | TSource>
Returns the element at a specified index in a sequence or a default value if the index is out of range.
Parameters
- index: number
  The zero-based index of the element to retrieve.
Returns Promise<null | TSource>
null if the index is outside the bounds of the source sequence; otherwise, the element at the specified position in the source sequence.
- Defined in src/types/IAsyncParallel.ts:130

first

first(predicate?: (x: TSource) => boolean): Promise<TSource>
Parameters
- Optionalpredicate: (x: TSource) => boolean
Returns Promise<TSource>
Throws
Sequence contains no elements

Throws
Sequence contains no matching elements
- Defined in src/types/IAsyncParallel.ts:135

firstAsync

firstAsync(predicate: (x: TSource) => Promise<boolean>): Promise<TSource>
Returns the first element in a sequence that satisfies a specified condition.
Parameters
- predicate: (x: TSource) => Promise<boolean>
  A function to test each element for a condition.
Returns Promise<TSource>
The first element in the sequence that passes the test in the specified predicate function.

Throws
No elements in Iteration matching predicate
- Defined in src/types/IAsyncParallel.ts:142

firstOrDefault

firstOrDefault(predicate?: (x: TSource) => boolean): Promise<null | TSource>
Returns first element in sequence that satisfies predicate otherwise returns the first element in the sequence. Returns null if no value found.
Parameters
- Optionalpredicate: (x: TSource) => boolean
  A function to test each element for a condition. Optional.
Returns Promise<null | TSource>
The first element in the sequence or the first element that passes the test in the specified predicate function. Returns null if no value found.
- Defined in src/types/IAsyncParallel.ts:151

firstOrDefaultAsync

firstOrDefaultAsync(
predicate: (x: TSource) => Promise<boolean>,
): Promise<null | TSource>
Returns the first element of the sequence that satisfies a condition or a default value if no such element is found.
Parameters
- predicate: (x: TSource) => Promise<boolean>
  An async function to test each element for a condition.
Returns Promise<null | TSource>
null if source is empty or if no element passes the test specified by predicate; otherwise, the first element in source that passes the test specified by predicate.
- Defined in src/types/IAsyncParallel.ts:159

last

last(predicate?: (x: TSource) => boolean): Promise<TSource>
Parameters
- Optionalpredicate: (x: TSource) => boolean
Returns Promise<TSource>
Throws
Sequence contains no elements

Throws
Sequence contains no matching element
- Defined in src/types/IAsyncParallel.ts:164

lastAsync

lastAsync(predicate: (x: TSource) => Promise<boolean>): Promise<TSource>
Parameters
- predicate: (x: TSource) => Promise<boolean>
Returns Promise<TSource>
Throws
Sequence contains no matching element
- Defined in src/types/IAsyncParallel.ts:168

lastOrDefault

lastOrDefault(predicate?: (x: TSource) => boolean): Promise<null | TSource>
Parameters
- Optionalpredicate: (x: TSource) => boolean
Returns Promise<null | TSource>
- Defined in src/types/IAsyncParallel.ts:169

lastOrDefaultAsync

lastOrDefaultAsync(
predicate: (x: TSource) => Promise<boolean>,
): Promise<null | TSource>
Parameters
- predicate: (x: TSource) => Promise<boolean>
Returns Promise<null | TSource>
- Defined in src/types/IAsyncParallel.ts:170

max

max(this: IAsyncParallel<number>): Promise<number>
Returns the maximum value in a sequence of values.
Parameters
- this: IAsyncParallel<number>
  Async Iteration of Numbers
Returns Promise<number>
Throws
Sequence contains no elements
- Defined in src/types/IAsyncParallel.ts:176
max(selector: (x: TSource) => number): Promise<number>
Invokes a transform function on each element of a sequence and returns the maximum value.
Parameters
- selector: (x: TSource) => number
  A transform function to apply to each element.
Returns Promise<number>
Throws
Sequence contains no elements
- Defined in src/types/IAsyncParallel.ts:182

maxAsync

maxAsync(selector: (x: TSource) => Promise<number>): Promise<number>
Invokes an async transform function on each element of a sequence and returns the maximum value.
Parameters
- selector: (x: TSource) => Promise<number>
  A transform function to apply to each element.
Returns Promise<number>
Throws
Sequence contains no elements
- Defined in src/types/IAsyncParallel.ts:188

min

min(this: IAsyncParallel<number>): Promise<number>
Returns the minimum value in a sequence of values.
Parameters
- this: IAsyncParallel<number>
Returns Promise<number>
Throws
Sequence contains no elements
- Defined in src/types/IAsyncParallel.ts:193
min(selector: (x: TSource) => number): Promise<number>
Invokes a transform function on each element of a sequence and returns the minimum value.
Parameters
- selector: (x: TSource) => number
  A transform function to apply to each element.
Returns Promise<number>
Throws
Sequence contains no elements
- Defined in src/types/IAsyncParallel.ts:199

minAsync

minAsync(selector: (x: TSource) => Promise<number>): Promise<number>
Invokes a transform function on each element of a sequence and returns the minimum value.
Parameters
- selector: (x: TSource) => Promise<number>
  A transform function to apply to each element.
Returns Promise<number>
Throws
Sequence contains no elements
- Defined in src/types/IAsyncParallel.ts:205

partition

partition(
predicate: (x: TSource) => boolean,
): Promise<[pass: TSource[], fail: TSource[]]>
Partitions the values into a tuple of failing and passing arrays
Parameters
- predicate: (x: TSource) => boolean
  Predicate to determine whether a value passes or fails
Returns Promise<[pass: TSource[], fail: TSource[]]>
[values that pass, values that fail]
- Defined in src/types/IAsyncParallel.ts:217

partitionAsync

partitionAsync(
predicate: (x: TSource) => Promise<boolean>,
): Promise<[pass: TSource[], fail: TSource[]]>
Partitions the values into a tuple of failing and passing arrays
Parameters
- predicate: (x: TSource) => Promise<boolean>
  Async predicate to determine whether a value passes or fails
Returns Promise<[pass: TSource[], fail: TSource[]]>
[values that pass, values that fail]
- Defined in src/types/IAsyncParallel.ts:223

single

single(predicate?: (x: TSource) => boolean): Promise<TSource>
Parameters
- Optionalpredicate: (x: TSource) => boolean
Returns Promise<TSource>
- Defined in src/types/IAsyncParallel.ts:225

singleAsync

singleAsync(predicate: (x: TSource) => Promise<boolean>): Promise<TSource>
Parameters
- predicate: (x: TSource) => Promise<boolean>
Returns Promise<TSource>
Throws
Sequence contains more than one matching element

Throws
Sequence contains no matching element
- Defined in src/types/IAsyncParallel.ts:230

singleOrDefault

singleOrDefault(predicate?: (x: TSource) => boolean): Promise<null | TSource>
Parameters
- Optionalpredicate: (x: TSource) => boolean
Returns Promise<null | TSource>
Throws
Sequence contains more than one matching element
- Defined in src/types/IAsyncParallel.ts:234

singleOrDefaultAsync

singleOrDefaultAsync(
predicate: (x: TSource) => Promise<boolean>,
): Promise<null | TSource>
Parameters
- predicate: (x: TSource) => Promise<boolean>
Returns Promise<null | TSource>
Throws
Sequence contains more than one matching element
- Defined in src/types/IAsyncParallel.ts:238

sum

sum(this: IAsyncParallel<number>): Promise<number>
Computes the sum of the sequence of numeric values.
Parameters
- this: IAsyncParallel<number>
Returns Promise<number>
A promise of the sum of the values in the sequence.
- Defined in src/types/IAsyncParallel.ts:243
sum(selector: (x: TSource) => number): Promise<number>
Computes the sum of the sequence of numeric values that are obtained by invoking a transform function on each element of the input sequence.
Parameters
- selector: (x: TSource) => number
  A transform function to apply to each element.
Returns Promise<number>
A promise of the sum of the projected values.
- Defined in src/types/IAsyncParallel.ts:250

sumAsync

sumAsync(selector: (x: TSource) => Promise<number>): Promise<number>
Computes the sum of the sequence of numeric values that are obtained by invoking a transform function on each element of the input sequence.
Parameters
- selector: (x: TSource) => Promise<number>
  An async transform function to apply to each element.
Returns Promise<number>
A promise of the sum of the projected values.
- Defined in src/types/IAsyncParallel.ts:257

toArray

toArray(): Promise<TSource[]>
Creates an array from a IAsyncEnumerable or IParallelEnumerable

Returns Promise<TSource[]>
An array of elements
- Defined in src/types/IAsyncParallel.ts:262

toMap

toMap<TKey>(selector: (x: TSource) => TKey): Promise<Map<TKey, TSource[]>>
Converts the async or parallel iteration to a Map<TKey, TSource[]>.
Type Parameters
- TKey
Parameters
- selector: (x: TSource) => TKey
  A function to serve as a key selector.
Returns Promise<Map<TKey, TSource[]>>
A promise for Map<TKey, TSource[]>
- Defined in src/types/IAsyncParallel.ts:268

toMapAsync

toMapAsync<TKey>(
selector: (x: TSource) => Promise<TKey>,
): Promise<Map<TKey, TSource[]>>
Converts the async or parallel iteration to a Map<TKey, TSource[]>.
Type Parameters
- TKey
Parameters
- selector: (x: TSource) => Promise<TKey>
  An async function to serve as a key selector.
Returns Promise<Map<TKey, TSource[]>>
A promise for Map<TKey, TSource[]>
- Defined in src/types/IAsyncParallel.ts:274

toObject

toObject<TKey extends string | number | symbol>(
selector: (x: TSource) => TKey,
): Promise<Record<TKey, TSource>>
Converts the Iteration to an Object. Duplicate values will be overriden.
Type Parameters
- TKey extends string | number | symbol
Parameters
- selector: (x: TSource) => TKey
  A function to determine the Key based on the value.
Returns Promise<Record<TKey, TSource>>
Promise of KVP Object
- Defined in src/types/IAsyncParallel.ts:280

toObjectAsync

toObjectAsync<TKey extends string | number | symbol>(
selector: (x: TSource) => Promise<TKey>,
): Promise<Record<TKey, TSource>>
Converts the Iteration to an Object. Duplicate values will be overriden.
Type Parameters
- TKey extends string | number | symbol
Parameters
- selector: (x: TSource) => Promise<TKey>
  An async function to determine the Key based on the value.
Returns Promise<Record<TKey, TSource>>
Promise of KVP Object
- Defined in src/types/IAsyncParallel.ts:286

toSet

toSet(): Promise<Set<TSource>>
Converts the async iteration to a Set

Returns Promise<Set<TSource>>
A promise for a set containing the iteration values
- Defined in src/types/IAsyncParallel.ts:291

Interface IAsyncParallel<TSource>

Type Parameters

Hierarchy (View Summary)

Index

Methods

Methods

[asyncIterator]

Returns AsyncIterableIterator<TSource>

aggregate

Parameters

Returns Promise<TSource>

Type Parameters

Parameters

Returns Promise<TAccumulate>

Type Parameters

Parameters

Returns Promise<TResult>

all

Parameters

Returns Promise<boolean>

allAsync

Parameters

Returns Promise<boolean>

any

Parameters

Returns Promise<boolean>

anyAsync

Parameters

Returns Promise<boolean>

average

Parameters

Returns Promise<number>

Throws

Parameters

Returns Promise<number>

Throws

averageAsync

Parameters

Returns Promise<number>

Throws

contains

Parameters

Returns Promise<boolean>

containsAsync

Parameters

Returns Promise<boolean>

count

Parameters

Returns Promise<number>

countAsync

Parameters

Returns Promise<number>

elementAt

Parameters

Returns Promise<TSource>

Throws

elementAtOrDefault

Parameters

Returns Promise<null | TSource>

first

Parameters

Returns Promise<TSource>

Throws

Throws

firstAsync

Parameters

Returns Promise<TSource>

Throws

firstOrDefault

Parameters

Returns Promise<null | TSource>

firstOrDefaultAsync

Parameters

Returns Promise<null | TSource>

last

Parameters

Returns Promise<TSource>

Throws

Throws

lastAsync