Interface IParallelEnumerable<TSource>

Parallel Async Iterable type with methods from LINQ.

interface IParallelEnumerable<TSource> {
    dataFunc: TypedData<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>;
    append(element: TSource): IParallelEnumerable<TSource>;
    asAsync(): IAsyncEnumerable<TSource>;
    average(this: IAsyncParallel<number>): Promise<number>;
    average(selector: (x: TSource) => number): Promise<number>;
    averageAsync(selector: (x: TSource) => Promise<number>): Promise<number>;
    chunk(size: number): IParallelEnumerable<TSource[]>;
    concatenate(second: IAsyncParallel<TSource>): IParallelEnumerable<TSource>;
    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>;
    defaultIfEmpty(
        defaultValue: TSource | Promise<TSource>,
    ): IParallelEnumerable<TSource>;
    distinct(
        comparer?: IEqualityComparer<TSource>,
    ): IParallelEnumerable<TSource>;
    distinctAsync(
        comparer: IAsyncEqualityComparer<TSource>,
    ): IParallelEnumerable<TSource>;
    each(action: (x: TSource) => void): IParallelEnumerable<TSource>;
    eachAsync(
        action: (x: TSource) => Promise<void>,
    ): IParallelEnumerable<TSource>;
    elementAt(index: number): Promise<TSource>;
    elementAtOrDefault(index: number): Promise<null | TSource>;
    except(
        second: IAsyncParallel<TSource>,
        comparer?: IEqualityComparer<TSource>,
    ): IParallelEnumerable<TSource>;
    exceptAsync(
        second: IAsyncParallel<TSource>,
        comparer: IAsyncEqualityComparer<TSource>,
    ): IParallelEnumerable<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>;
    groupBy<TKey extends SelectorKeyType>(
        keySelector: (x: TSource) => TKey,
    ): IParallelEnumerable<IGrouping<TKey, TSource>>;
    groupBy<TKey>(
        keySelector: (x: TSource) => TKey,
        comparer: IEqualityComparer<TKey>,
    ): IParallelEnumerable<IGrouping<TKey, TSource>>;
    groupByAsync<TKey extends SelectorKeyType>(
        keySelector: (x: TSource) => Promise<TKey>,
    ): IParallelEnumerable<IGrouping<TKey, TSource>>;
    groupByAsync<TKey>(
        keySelector: (x: TSource) => TKey | Promise<TKey>,
        comparer: IEqualityComparer<TKey> | IAsyncEqualityComparer<TKey>,
    ): IParallelEnumerable<IGrouping<TKey, TSource>>;
    groupByWithSel<TElement, TKey extends SelectorKeyType>(
        keySelector: (x: TSource) => TKey,
        elementSelector: (x: TSource) => TElement,
    ): IParallelEnumerable<IGrouping<TKey, TElement>>;
    groupByWithSel<TKey, TElement>(
        keySelector: (x: TSource) => TKey,
        elementSelector: (x: TSource) => TElement,
        comparer: IEqualityComparer<TKey>,
    ): IParallelEnumerable<IGrouping<TKey, TElement>>;
    groupJoin<TInner, TKey, TResult>(
        inner: Iterable<TInner, any, any> | AsyncIterable<TInner, any, any>,
        outerKeySelector: (value: TSource) => TKey,
        innerKeySelector: (value: TInner) => TKey,
        resultSelector: (element: TSource, collection: TInner[]) => TResult,
        comparer?: IEqualityComparer<TKey>,
    ): IParallelEnumerable<TResult>;
    groupJoinAsync<TInner, TKey, TResult>(
        inner: Iterable<TInner, any, any> | AsyncIterable<TInner, any, any>,
        outerKeySelector: (value: TSource) => TKey | Promise<TKey>,
        innerKeySelector: (value: TInner) => TKey | Promise<TKey>,
        resultSelector: (
            element: TSource,
            collection: TInner[],
        ) => TResult | Promise<TResult>,
        comparer?: IEqualityComparer<TKey>,
    ): IParallelEnumerable<TResult>;
    intersect(
        second: IAsyncParallel<TSource>,
        comparer?: IEqualityComparer<TSource>,
    ): IParallelEnumerable<TSource>;
    intersectAsync(
        second: IAsyncParallel<TSource>,
        comparer: IAsyncEqualityComparer<TSource>,
    ): IParallelEnumerable<TSource>;
    joinByKey<TInner, TKey, TResult>(
        inner: IAsyncParallel<TInner>,
        outerKeySelector: (x: TSource) => TKey,
        innerKeySelector: (x: TInner) => TKey,
        resultSelector: (x: TSource, y: TInner) => TResult,
        comparer?: IEqualityComparer<TKey>,
    ): IParallelEnumerable<TResult>;
    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>;
    ofType<TType extends OfType>(
        type: TType,
    ): IParallelEnumerable<InferType<TType>>;
    order(comparer?: IComparer<TSource>): IOrderedParallelEnumerable<TSource>;
    orderBy<TKey>(
        predicate: (x: TSource) => TKey,
        comparer?: IComparer<TKey>,
    ): IOrderedParallelEnumerable<TSource>;
    orderByAsync<TKey>(
        predicate: (x: TSource) => Promise<TKey>,
        comparer?: IComparer<TKey>,
    ): IOrderedParallelEnumerable<TSource>;
    orderByDescending<TKey>(
        predicate: (x: TSource) => TKey,
        comparer?: IComparer<TKey>,
    ): IParallelEnumerable<TSource>;
    orderByDescendingAsync<TKey>(
        predicate: (x: TSource) => Promise<TKey>,
        comparer?: IComparer<TKey>,
    ): IParallelEnumerable<TSource>;
    orderDescending(
        comparer?: IComparer<TSource>,
    ): IParallelEnumerable<TSource>;
    partition(
        predicate: (x: TSource) => boolean,
    ): Promise<[pass: TSource[], fail: TSource[]]>;
    partitionAsync(
        predicate: (x: TSource) => Promise<boolean>,
    ): Promise<[pass: TSource[], fail: TSource[]]>;
    prepend(element: TSource): IParallelEnumerable<TSource>;
    reverse(): IParallelEnumerable<TSource>;
    select<TResult>(
        selector: (x: TSource, index: number) => TResult,
    ): IParallelEnumerable<TResult>;
    select<TKey extends string | number | symbol>(
        key: TKey,
    ): IParallelEnumerable<TSource[TKey]>;
    selectAsync<TResult>(
        selector: (x: TSource, index: number) => Promise<TResult>,
    ): IParallelEnumerable<TResult>;
    selectAsync<TKey extends string | number | symbol, TResult>(
        this: IParallelEnumerable<{ [key: string]: Promise<TResult> }>,
        selector: TKey,
    ): IParallelEnumerable<TResult>;
    selectMany<TResult>(
        selector: (x: TSource, index: number) => Iterable<TResult>,
    ): IParallelEnumerable<TResult>;
    selectMany<
        TBindedSource extends { [key: string]: Iterable<TOut, any, any> },
        TOut,
    >(
        this: IParallelEnumerable<TBindedSource>,
        selector: keyof TBindedSource,
    ): IParallelEnumerable<TOut>;
    selectManyAsync<TResult>(
        selector: (
            x: TSource,
            index: number,
        ) => Promise<Iterable<TResult, any, any>>,
    ): IParallelEnumerable<TResult>;
    sequenceEquals(
        second: IAsyncParallel<TSource>,
        comparer?: IEqualityComparer<TSource>,
    ): Promise<boolean>;
    sequenceEqualsAsync(
        second: IAsyncParallel<TSource>,
        comparer?: IAsyncEqualityComparer<TSource>,
    ): Promise<boolean>;
    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>;
    skip(count: number): IParallelEnumerable<TSource>;
    skipWhile(
        predicate: (x: TSource, index: number) => boolean,
    ): IParallelEnumerable<TSource>;
    skipWhileAsync(
        predicate: (x: TSource, index: number) => Promise<boolean>,
    ): IParallelEnumerable<TSource>;
    sum(this: IAsyncParallel<number>): Promise<number>;
    sum(selector: (x: TSource) => number): Promise<number>;
    sumAsync(selector: (x: TSource) => Promise<number>): Promise<number>;
    take(amount: number): IParallelEnumerable<TSource>;
    takeWhile(
        predicate: (x: TSource, index: number) => boolean,
    ): IParallelEnumerable<TSource>;
    takeWhileAsync(
        predicate: (x: TSource, index: number) => Promise<boolean>,
    ): IParallelEnumerable<TSource>;
    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>>;
    union(
        second: IAsyncParallel<TSource>,
        comparer?: IEqualityComparer<TSource>,
    ): IParallelEnumerable<TSource>;
    unionAsync(
        second: IAsyncParallel<TSource>,
        comparer?: IAsyncEqualityComparer<TSource>,
    ): IParallelEnumerable<TSource>;
    where(
        predicate: (x: TSource, index: number) => boolean,
    ): IParallelEnumerable<TSource>;
    whereAsync(
        predicate: (x: TSource, index: number) => Promise<boolean>,
    ): IParallelEnumerable<TSource>;
    zip<TSecond, TResult>(
        second: IAsyncParallel<TSecond>,
        resultSelector: (x: TSource, y: TSecond) => TResult,
    ): IParallelEnumerable<TResult>;
    zip<TSecond>(
        second: IAsyncParallel<TSecond>,
    ): IParallelEnumerable<[TSource, TSecond]>;
    zipAsync<TSecond, TResult>(
        second: IAsyncParallel<TSecond>,
        resultSelector: (x: TSource, y: TSecond) => Promise<TResult>,
    ): IParallelEnumerable<TResult>;
}

Type Parameters

TSource

Hierarchy (View Summary)

IAsyncParallel<TSource>
- IParallelEnumerable
  - IOrderedParallelEnumerable

Index

Properties

dataFunc

Methods

[asyncIterator] aggregate all allAsync any anyAsync append asAsync average averageAsync chunk concatenate contains containsAsync count countAsync defaultIfEmpty distinct distinctAsync each eachAsync elementAt elementAtOrDefault except exceptAsync first firstAsync firstOrDefault firstOrDefaultAsync groupBy groupByAsync groupByWithSel groupJoin groupJoinAsync intersect intersectAsync joinByKey last lastAsync lastOrDefault lastOrDefaultAsync max maxAsync min minAsync ofType order orderBy orderByAsync orderByDescending orderByDescendingAsync orderDescending partition partitionAsync prepend reverse select selectAsync selectMany selectManyAsync sequenceEquals sequenceEqualsAsync single singleAsync singleOrDefault singleOrDefaultAsync skip skipWhile skipWhileAsync sum sumAsync take takeWhile takeWhileAsync toArray toMap toMapAsync toObject toObjectAsync toSet union unionAsync where whereAsync zip zipAsync

Properties

`Readonly`dataFunc

dataFunc: TypedData<TSource>

Used for processing.

Methods

[asyncIterator]

"[asyncIterator]"(): AsyncIterableIterator<TSource>
Returns AsyncIterableIterator<TSource>
Inherited from IAsyncParallel.[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.
Inherited from IAsyncParallel.aggregate
- 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.
Inherited from IAsyncParallel.aggregate
- 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.
Inherited from IAsyncParallel.aggregate
- 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.
Inherited from IAsyncParallel.all
- 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.
Inherited from IAsyncParallel.allAsync
- 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.
Inherited from IAsyncParallel.any
- 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.
Inherited from IAsyncParallel.anyAsync
- Defined in src/types/IAsyncParallel.ts:60

append

append(element: TSource): IParallelEnumerable<TSource>
Appends a value to the end of the sequence.
Parameters
- element: TSource
  The value to append to the sequence.
Returns IParallelEnumerable<TSource>
An IParallelEnumerable that ends with the specified element.
- Defined in src/types/IParallelEnumerable.ts:28

asAsync

asAsync(): IAsyncEnumerable<TSource>
Converts the parallel iterable to an

Returns IAsyncEnumerable<TSource>
An IAsyncEnumerable

See
- Defined in src/types/IParallelEnumerable.ts:33

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.
Inherited from IAsyncParallel.average
- 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.
Inherited from IAsyncParallel.average
- 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.
Inherited from IAsyncParallel.averageAsync
- Defined in src/types/IAsyncParallel.ts:82

chunk

chunk(size: number): IParallelEnumerable<TSource[]>
Splits the elements of a sequence into chunks of size at most size.
Parameters
- size: number
  The maximum size of each chunk.
Returns IParallelEnumerable<TSource[]>
An IParallelEnumerable that contains the elements the input sequence split into chunks of size size.
- Defined in src/types/IParallelEnumerable.ts:39

concatenate

concatenate(second: IAsyncParallel<TSource>): IParallelEnumerable<TSource>
Concatenates two async sequences.
Parameters
- second: IAsyncParallel<TSource>
  The async sequence to concatenate to the first sequence.
Returns IParallelEnumerable<TSource>
An IParallelEnumerable that contains the concatenated elements of the two sequences.
- Defined in src/types/IParallelEnumerable.ts:45

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.
Inherited from IAsyncParallel.contains
- 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.
Inherited from IAsyncParallel.containsAsync
- 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.
Inherited from IAsyncParallel.count
- 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.
Inherited from IAsyncParallel.countAsync
- Defined in src/types/IAsyncParallel.ts:114

defaultIfEmpty

defaultIfEmpty(
defaultValue: TSource | Promise<TSource>,
): IParallelEnumerable<TSource>
Returns the elements of an IParallelEnumerable, or a default valued singleton collection if the sequence is empty.
Parameters
- defaultValue: TSource | Promise<TSource>
  The value, or Promise that gives back that value, to return if the sequence is empty.
Returns IParallelEnumerable<TSource>
An IParallelEnumerable that contains defaultValue if source is empty; otherwise, source.
- Defined in src/types/IParallelEnumerable.ts:51

distinct

distinct(comparer?: IEqualityComparer<TSource>): IParallelEnumerable<TSource>
Returns distinct elements from a sequence by using the default or specified equality comparer to compare values.
Parameters
- Optionalcomparer: IEqualityComparer<TSource>
  An IEqualityComparer to compare values. Optional. Defaults to Strict Equality Comparison.
Returns IParallelEnumerable<TSource>
An IParallelEnumerable that contains distinct elements from the source sequence.
- Defined in src/types/IParallelEnumerable.ts:57

distinctAsync

distinctAsync(
comparer: IAsyncEqualityComparer<TSource>,
): IParallelEnumerable<TSource>
Returns distinct elements from a sequence by using the specified equality comparer to compare values.
Parameters
- comparer: IAsyncEqualityComparer<TSource>
  An IAsyncEqualityComparer to compare values.
Returns IParallelEnumerable<TSource>
An IParallelEnumerable that contains distinct elements from the source sequence.
- Defined in src/types/IParallelEnumerable.ts:63

each

each(action: (x: TSource) => void): IParallelEnumerable<TSource>
Performs a specified action on each element of the IParallelEnumerable. The order of execution is not guaranteed.
Parameters
- action: (x: TSource) => void
  The action to take an each element
Returns IParallelEnumerable<TSource>
A new IParallelEnumerable that executes the action provided.
- Defined in src/types/IParallelEnumerable.ts:70

eachAsync

eachAsync(action: (x: TSource) => Promise<void>): IParallelEnumerable<TSource>
Performs a specified action on each element of the IParallelEnumerable. The order of execution is not guaranteed.
Parameters
- action: (x: TSource) => Promise<void>
  The async action to take an each element
Returns IParallelEnumerable<TSource>
A new IParallelEnumerable that executes the action provided.
- Defined in src/types/IParallelEnumerable.ts:77

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.
Inherited from IAsyncParallel.elementAt
- 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.
Inherited from IAsyncParallel.elementAtOrDefault
- Defined in src/types/IAsyncParallel.ts:130

except

except(
second: IAsyncParallel<TSource>,
comparer?: IEqualityComparer<TSource>,
): IParallelEnumerable<TSource>
Produces the set difference of two sequences by using the comparer provided or EqualityComparer to compare values.
Parameters
- second: IAsyncParallel<TSource>
  An IAsyncParallel whose elements that also occur in the first sequence will cause those elements to be removed from the returned sequence.
- Optionalcomparer: IEqualityComparer<TSource>
  An IEqualityComparer to compare values. Optional.
Returns IParallelEnumerable<TSource>
A sequence that contains the set difference of the elements of two sequences.
- Defined in src/types/IParallelEnumerable.ts:86

exceptAsync

exceptAsync(
second: IAsyncParallel<TSource>,
comparer: IAsyncEqualityComparer<TSource>,
): IParallelEnumerable<TSource>
Produces the set difference of two sequences by using the comparer provided to compare values.
Parameters
- second: IAsyncParallel<TSource>
  An IAsyncParallel whose elements that also occur in the first sequence will cause those elements to be removed from the returned sequence.
- comparer: IAsyncEqualityComparer<TSource>
  An IAsyncEqualityComparer to compare values.
Returns IParallelEnumerable<TSource>
A sequence that contains the set difference of the elements of two sequences.
- Defined in src/types/IParallelEnumerable.ts:95

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
Inherited from IAsyncParallel.first
- 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
Inherited from IAsyncParallel.firstAsync
- 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.
Inherited from IAsyncParallel.firstOrDefault
- 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.
Inherited from IAsyncParallel.firstOrDefaultAsync
- Defined in src/types/IAsyncParallel.ts:159

groupBy

groupBy<TKey extends SelectorKeyType>(
keySelector: (x: TSource) => TKey,
): IParallelEnumerable<IGrouping<TKey, TSource>>
Groups the elements of a sequence according to a specified key selector function.
Type Parameters
- TKey extends SelectorKeyType
Parameters
- keySelector: (x: TSource) => TKey
  A function to extract the key for each element.
Returns IParallelEnumerable<IGrouping<TKey, TSource>>
An IParallelEnumerable<IGrouping<TKey, TSource>> where each IGrouping<TKey,TElement> object contains a sequence of objects and a key.
- Defined in src/types/IParallelEnumerable.ts:103
groupBy<TKey>(
keySelector: (x: TSource) => TKey,
comparer: IEqualityComparer<TKey>,
): IParallelEnumerable<IGrouping<TKey, TSource>>
Groups the elements of a sequence according to a key selector function. The keys are compared by using a comparer and each group's elements are projected by using a specified function.
Type Parameters
- TKey
Parameters
- keySelector: (x: TSource) => TKey
  A function to extract the key for each element.
- comparer: IEqualityComparer<TKey>
  An IEqualityComparer to compare keys.
Returns IParallelEnumerable<IGrouping<TKey, TSource>>
An IParallelEnumerable<IGrouping<TKey, TSource>> where each IGrouping<TKey,TElement> object contains a sequence of objects and a key.
- Defined in src/types/IParallelEnumerable.ts:113

groupByAsync

groupByAsync<TKey extends SelectorKeyType>(
keySelector: (x: TSource) => Promise<TKey>,
): IParallelEnumerable<IGrouping<TKey, TSource>>
Groups the elements of a sequence according to a specified key selector function.
Type Parameters
- TKey extends SelectorKeyType
Parameters
- keySelector: (x: TSource) => Promise<TKey>
  An async function to extract the key for each element.
Returns IParallelEnumerable<IGrouping<TKey, TSource>>
An IParallelEnumerable<IGrouping<TKey, TSource>> where each IGrouping<TKey,TElement> object contains a sequence of objects and a key.
- Defined in src/types/IParallelEnumerable.ts:122
groupByAsync<TKey>(
keySelector: (x: TSource) => TKey | Promise<TKey>,
comparer: IEqualityComparer<TKey> | IAsyncEqualityComparer<TKey>,
): IParallelEnumerable<IGrouping<TKey, TSource>>
Groups the elements of a sequence according to a specified key selector function.
Type Parameters
- TKey
Parameters
- keySelector: (x: TSource) => TKey | Promise<TKey>
  An async function to extract the key for each element.
- comparer: IEqualityComparer<TKey> | IAsyncEqualityComparer<TKey>
  An IEqualityComparer or IAsyncEqualityComparer to compare keys.
Returns IParallelEnumerable<IGrouping<TKey, TSource>>
An IParallelEnumerable<IGrouping<TKey, TSource>> where each IGrouping<TKey,TElement> object contains a sequence of objects and a key.
- Defined in src/types/IParallelEnumerable.ts:131

groupByWithSel

groupByWithSel<TElement, TKey extends SelectorKeyType>(
keySelector: (x: TSource) => TKey,
elementSelector: (x: TSource) => TElement,
): IParallelEnumerable<IGrouping<TKey, TElement>>
Type Parameters
- TElement
- TKey extends SelectorKeyType
Parameters
- keySelector: (x: TSource) => TKey
- elementSelector: (x: TSource) => TElement
Returns IParallelEnumerable<IGrouping<TKey, TElement>>
- Defined in src/types/IParallelEnumerable.ts:136
groupByWithSel<TKey, TElement>(
    keySelector: (x: TSource) => TKey,
    elementSelector: (x: TSource) => TElement,
    comparer: IEqualityComparer<TKey>,
): IParallelEnumerable<IGrouping<TKey, TElement>>
Type Parameters
- TKey
- TElement
Parameters
- keySelector: (x: TSource) => TKey
- elementSelector: (x: TSource) => TElement
- comparer: IEqualityComparer<TKey>
Returns IParallelEnumerable<IGrouping<TKey, TElement>>
- Defined in src/types/IParallelEnumerable.ts:139

groupJoin

groupJoin<TInner, TKey, TResult>(
    inner: Iterable<TInner, any, any> | AsyncIterable<TInner, any, any>,
    outerKeySelector: (value: TSource) => TKey,
    innerKeySelector: (value: TInner) => TKey,
    resultSelector: (element: TSource, collection: TInner[]) => TResult,
    comparer?: IEqualityComparer<TKey>,
): IParallelEnumerable<TResult>
Correlates the elements of two sequences based on equality of keys and groups the results.
Type Parameters
- TInner
- TKey
- TResult
Parameters
- inner: Iterable<TInner, any, any> | AsyncIterable<TInner, any, any>
  The sequence to join to the first sequence.
- outerKeySelector: (value: TSource) => TKey
  The sequence to join to the first sequence.
- innerKeySelector: (value: TInner) => TKey
  A function to extract the join key from each element of the second sequence.
- resultSelector: (element: TSource, collection: TInner[]) => TResult
  A function to create a result element from an element from the first sequence and a collection of matching elements from the second sequence.
- Optionalcomparer: IEqualityComparer<TKey>
  To compare keys. Optional.
Returns IParallelEnumerable<TResult>
An IParallelEnumerable that contains elements of type TResult that are obtained by performing a grouped join on two sequences.
- Defined in src/types/IParallelEnumerable.ts:152

groupJoinAsync

groupJoinAsync<TInner, TKey, TResult>(
    inner: Iterable<TInner, any, any> | AsyncIterable<TInner, any, any>,
    outerKeySelector: (value: TSource) => TKey | Promise<TKey>,
    innerKeySelector: (value: TInner) => TKey | Promise<TKey>,
    resultSelector: (
        element: TSource,
        collection: TInner[],
    ) => TResult | Promise<TResult>,
    comparer?: IEqualityComparer<TKey>,
): IParallelEnumerable<TResult>
Correlates the elements of two sequences based on equality of keys and groups the results.
Type Parameters
- TInner
- TKey
- TResult
Parameters
- inner: Iterable<TInner, any, any> | AsyncIterable<TInner, any, any>
  The sequence to join to the first sequence. Can be async.
- outerKeySelector: (value: TSource) => TKey | Promise<TKey>
  The sequence to join to the first sequence. Can be async.
- innerKeySelector: (value: TInner) => TKey | Promise<TKey>
  A function to extract the join key from each element of the second sequence.
- resultSelector: (element: TSource, collection: TInner[]) => TResult | Promise<TResult>
  A function to create a result element from an element from the first sequence and a collection of matching elements from the second sequence. Can be async.
- Optionalcomparer: IEqualityComparer<TKey>
  To compare keys. Optional.
Returns IParallelEnumerable<TResult>
An IParallelEnumerable that contains elements of type TResult that are obtained by performing a grouped join on two sequences.
- Defined in src/types/IParallelEnumerable.ts:167

intersect

intersect(
second: IAsyncParallel<TSource>,
comparer?: IEqualityComparer<TSource>,
): IParallelEnumerable<TSource>
Parameters
- second: IAsyncParallel<TSource>
- Optionalcomparer: IEqualityComparer<TSource>
Returns IParallelEnumerable<TSource>
- Defined in src/types/IParallelEnumerable.ts:174

intersectAsync

intersectAsync(
second: IAsyncParallel<TSource>,
comparer: IAsyncEqualityComparer<TSource>,
): IParallelEnumerable<TSource>
Parameters
- second: IAsyncParallel<TSource>
- comparer: IAsyncEqualityComparer<TSource>
Returns IParallelEnumerable<TSource>
- Defined in src/types/IParallelEnumerable.ts:176

joinByKey

joinByKey<TInner, TKey, TResult>(
    inner: IAsyncParallel<TInner>,
    outerKeySelector: (x: TSource) => TKey,
    innerKeySelector: (x: TInner) => TKey,
    resultSelector: (x: TSource, y: TInner) => TResult,
    comparer?: IEqualityComparer<TKey>,
): IParallelEnumerable<TResult>
Type Parameters
- TInner
- TKey
- TResult
Parameters
- inner: IAsyncParallel<TInner>
- outerKeySelector: (x: TSource) => TKey
- innerKeySelector: (x: TInner) => TKey
- resultSelector: (x: TSource, y: TInner) => TResult
- Optionalcomparer: IEqualityComparer<TKey>
Returns IParallelEnumerable<TResult>
- Defined in src/types/IParallelEnumerable.ts:179

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
Inherited from IAsyncParallel.last
- 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
Inherited from IAsyncParallel.lastAsync
- 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>
Inherited from IAsyncParallel.lastOrDefault
- 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>
Inherited from IAsyncParallel.lastOrDefaultAsync
- 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
Inherited from IAsyncParallel.max
- 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
Inherited from IAsyncParallel.max
- 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
Inherited from IAsyncParallel.maxAsync
- 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
Inherited from IAsyncParallel.min
- 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
Inherited from IAsyncParallel.min
- 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
Inherited from IAsyncParallel.minAsync
- Defined in src/types/IAsyncParallel.ts:205

ofType

ofType<TType extends OfType>(type: TType): IParallelEnumerable<InferType<TType>>
Type Parameters
- TType extends OfType
Parameters
- type: TType
Returns IParallelEnumerable<InferType<TType>>
- Defined in src/types/IParallelEnumerable.ts:185

order

order(comparer?: IComparer<TSource>): IOrderedParallelEnumerable<TSource>
Sorts the elements of a sequence in ascending order by using a specified or default comparer.
Parameters
- Optionalcomparer: IComparer<TSource>
  An IComparer to compare values. Optional.
Returns IOrderedParallelEnumerable<TSource>
An IOrderedParallelEnumerable whose elements are sorted.
- Defined in src/types/IParallelEnumerable.ts:191

orderBy

orderBy<TKey>(
predicate: (x: TSource) => TKey,
comparer?: IComparer<TKey>,
): IOrderedParallelEnumerable<TSource>
Type Parameters
- TKey
Parameters
- predicate: (x: TSource) => TKey
- Optionalcomparer: IComparer<TKey>
Returns IOrderedParallelEnumerable<TSource>
- Defined in src/types/IParallelEnumerable.ts:193

orderByAsync

orderByAsync<TKey>(
predicate: (x: TSource) => Promise<TKey>,
comparer?: IComparer<TKey>,
): IOrderedParallelEnumerable<TSource>
Type Parameters
- TKey
Parameters
- predicate: (x: TSource) => Promise<TKey>
- Optionalcomparer: IComparer<TKey>
Returns IOrderedParallelEnumerable<TSource>
- Defined in src/types/IParallelEnumerable.ts:196

orderByDescending

orderByDescending<TKey>(
predicate: (x: TSource) => TKey,
comparer?: IComparer<TKey>,
): IParallelEnumerable<TSource>
Type Parameters
- TKey
Parameters
- predicate: (x: TSource) => TKey
- Optionalcomparer: IComparer<TKey>
Returns IParallelEnumerable<TSource>
- Defined in src/types/IParallelEnumerable.ts:199

orderByDescendingAsync

orderByDescendingAsync<TKey>(
predicate: (x: TSource) => Promise<TKey>,
comparer?: IComparer<TKey>,
): IParallelEnumerable<TSource>
Type Parameters
- TKey
Parameters
- predicate: (x: TSource) => Promise<TKey>
- Optionalcomparer: IComparer<TKey>
Returns IParallelEnumerable<TSource>
- Defined in src/types/IParallelEnumerable.ts:202

orderDescending

orderDescending(comparer?: IComparer<TSource>): IParallelEnumerable<TSource>
Sorts the elements of a sequence in descending order by using a specified or default comparer.
Parameters
- Optionalcomparer: IComparer<TSource>
  An IComparer to compare values. Optional.
Returns IParallelEnumerable<TSource>
An IParallelEnumerable whose elements are sorted in descending order.
- Defined in src/types/IParallelEnumerable.ts:210

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]
Inherited from IAsyncParallel.partition
- 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]
Inherited from IAsyncParallel.partitionAsync
- Defined in src/types/IAsyncParallel.ts:223

prepend

prepend(element: TSource): IParallelEnumerable<TSource>
Adds a value to the beginning of the sequence.
Parameters
- element: TSource
  The value to prepend to the sequence.
Returns IParallelEnumerable<TSource>
An IParallelEnumerable that begins with the specified element.
- Defined in src/types/IParallelEnumerable.ts:217

reverse

reverse(): IParallelEnumerable<TSource>
Inverts the order of the elements in a sequence.

Returns IParallelEnumerable<TSource>
A sequence whose elements correspond to those of the input sequence in reverse order.
- Defined in src/types/IParallelEnumerable.ts:222

select

select<TResult>(
selector: (x: TSource, index: number) => TResult,
): IParallelEnumerable<TResult>
Type Parameters
- TResult
Parameters
- selector: (x: TSource, index: number) => TResult
Returns IParallelEnumerable<TResult>
- Defined in src/types/IParallelEnumerable.ts:223
select<TKey extends string | number | symbol>(
key: TKey,
): IParallelEnumerable<TSource[TKey]>
Type Parameters
- TKey extends string | number | symbol
Parameters
- key: TKey
Returns IParallelEnumerable<TSource[TKey]>
- Defined in src/types/IParallelEnumerable.ts:224

selectAsync

selectAsync<TResult>(
selector: (x: TSource, index: number) => Promise<TResult>,
): IParallelEnumerable<TResult>
Type Parameters
- TResult
Parameters
- selector: (x: TSource, index: number) => Promise<TResult>
Returns IParallelEnumerable<TResult>
- Defined in src/types/IParallelEnumerable.ts:225
selectAsync<TKey extends string | number | symbol, TResult>(
this: IParallelEnumerable<{ [key: string]: Promise<TResult> }>,
selector: TKey,
): IParallelEnumerable<TResult>
Type Parameters
- TKey extends string | number | symbol
- TResult
Parameters
- this: IParallelEnumerable<{ [key: string]: Promise<TResult> }>
- selector: TKey
Returns IParallelEnumerable<TResult>
- Defined in src/types/IParallelEnumerable.ts:227

selectMany

selectMany<TResult>(
selector: (x: TSource, index: number) => Iterable<TResult>,
): IParallelEnumerable<TResult>
Type Parameters
- TResult
Parameters
- selector: (x: TSource, index: number) => Iterable<TResult>
Returns IParallelEnumerable<TResult>
- Defined in src/types/IParallelEnumerable.ts:230
selectMany<
    TBindedSource extends { [key: string]: Iterable<TOut, any, any> },
    TOut,
>(
    this: IParallelEnumerable<TBindedSource>,
    selector: keyof TBindedSource,
): IParallelEnumerable<TOut>
Type Parameters
- TBindedSource extends { [key: string]: Iterable<TOut, any, any> }
- TOut
Parameters
- this: IParallelEnumerable<TBindedSource>
- selector: keyof TBindedSource
Returns IParallelEnumerable<TOut>
- Defined in src/types/IParallelEnumerable.ts:231

selectManyAsync

selectManyAsync<TResult>(
    selector: (
        x: TSource,
        index: number,
    ) => Promise<Iterable<TResult, any, any>>,
): IParallelEnumerable<TResult>
Type Parameters
- TResult
Parameters
- selector: (x: TSource, index: number) => Promise<Iterable<TResult, any, any>>
Returns IParallelEnumerable<TResult>
- Defined in src/types/IParallelEnumerable.ts:234

sequenceEquals

sequenceEquals(
second: IAsyncParallel<TSource>,
comparer?: IEqualityComparer<TSource>,
): Promise<boolean>
Parameters
- second: IAsyncParallel<TSource>
- Optionalcomparer: IEqualityComparer<TSource>
Returns Promise<boolean>
- Defined in src/types/IParallelEnumerable.ts:236

sequenceEqualsAsync

sequenceEqualsAsync(
second: IAsyncParallel<TSource>,
comparer?: IAsyncEqualityComparer<TSource>,
): Promise<boolean>
Parameters
- second: IAsyncParallel<TSource>
- Optionalcomparer: IAsyncEqualityComparer<TSource>
Returns Promise<boolean>
- Defined in src/types/IParallelEnumerable.ts:238

single

single(predicate?: (x: TSource) => boolean): Promise<TSource>
Parameters
- Optionalpredicate: (x: TSource) => boolean
Returns Promise<TSource>
Inherited from IAsyncParallel.single
- 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
Inherited from IAsyncParallel.singleAsync
- 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
Inherited from IAsyncParallel.singleOrDefault
- 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
Inherited from IAsyncParallel.singleOrDefaultAsync
- Defined in src/types/IAsyncParallel.ts:238

skip

skip(count: number): IParallelEnumerable<TSource>
Parameters
- count: number
Returns IParallelEnumerable<TSource>
- Defined in src/types/IParallelEnumerable.ts:240

skipWhile

skipWhile(
predicate: (x: TSource, index: number) => boolean,
): IParallelEnumerable<TSource>
Parameters
- predicate: (x: TSource, index: number) => boolean
Returns IParallelEnumerable<TSource>
- Defined in src/types/IParallelEnumerable.ts:241

skipWhileAsync

skipWhileAsync(
predicate: (x: TSource, index: number) => Promise<boolean>,
): IParallelEnumerable<TSource>
Parameters
- predicate: (x: TSource, index: number) => Promise<boolean>
Returns IParallelEnumerable<TSource>
- Defined in src/types/IParallelEnumerable.ts:242

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.
Inherited from IAsyncParallel.sum
- 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.
Inherited from IAsyncParallel.sum
- 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.
Inherited from IAsyncParallel.sumAsync
- Defined in src/types/IAsyncParallel.ts:257

take

take(amount: number): IParallelEnumerable<TSource>
Parameters
- amount: number
Returns IParallelEnumerable<TSource>
- Defined in src/types/IParallelEnumerable.ts:243

takeWhile

takeWhile(
predicate: (x: TSource, index: number) => boolean,
): IParallelEnumerable<TSource>
Parameters
- predicate: (x: TSource, index: number) => boolean
Returns IParallelEnumerable<TSource>
- Defined in src/types/IParallelEnumerable.ts:244

takeWhileAsync

takeWhileAsync(
predicate: (x: TSource, index: number) => Promise<boolean>,
): IParallelEnumerable<TSource>
Parameters
- predicate: (x: TSource, index: number) => Promise<boolean>
Returns IParallelEnumerable<TSource>
- Defined in src/types/IParallelEnumerable.ts:245

toArray

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

Returns Promise<TSource[]>
An array of elements
Inherited from IAsyncParallel.toArray
- 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[]>
Inherited from IAsyncParallel.toMap
- 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[]>
Inherited from IAsyncParallel.toMapAsync
- 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
Inherited from IAsyncParallel.toObject
- 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
Inherited from IAsyncParallel.toObjectAsync
- 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
Inherited from IAsyncParallel.toSet
- Defined in src/types/IAsyncParallel.ts:291

union

union(
second: IAsyncParallel<TSource>,
comparer?: IEqualityComparer<TSource>,
): IParallelEnumerable<TSource>
Parameters
- second: IAsyncParallel<TSource>
- Optionalcomparer: IEqualityComparer<TSource>
Returns IParallelEnumerable<TSource>
- Defined in src/types/IParallelEnumerable.ts:246

unionAsync

unionAsync(
second: IAsyncParallel<TSource>,
comparer?: IAsyncEqualityComparer<TSource>,
): IParallelEnumerable<TSource>
Parameters
- second: IAsyncParallel<TSource>
- Optionalcomparer: IAsyncEqualityComparer<TSource>
Returns IParallelEnumerable<TSource>
- Defined in src/types/IParallelEnumerable.ts:248

where

where(
predicate: (x: TSource, index: number) => boolean,
): IParallelEnumerable<TSource>
Filters a sequence of values based on a predicate. Each element's index is used in the logic of the predicate function.
Parameters
- predicate: (x: TSource, index: number) => boolean
  A function to test each source element for a condition; the second parameter of the function represents the index of the source element.
Returns IParallelEnumerable<TSource>
An IParallelEnumerable that contains elements from the input sequence that satisfy the condition.
- Defined in src/types/IParallelEnumerable.ts:257

whereAsync

whereAsync(
predicate: (x: TSource, index: number) => Promise<boolean>,
): IParallelEnumerable<TSource>
Filters a sequence of values based on a predicate. Each element's index is used in the logic of the predicate function.
Parameters
- predicate: (x: TSource, index: number) => Promise<boolean>
  A async function to test each source element for a condition; the second parameter of the function represents the index of the source element.
Returns IParallelEnumerable<TSource>
An IParallelEnumerable that contains elements from the input sequence that satisfy the condition.
- Defined in src/types/IParallelEnumerable.ts:265

zip

zip<TSecond, TResult>(
second: IAsyncParallel<TSecond>,
resultSelector: (x: TSource, y: TSecond) => TResult,
): IParallelEnumerable<TResult>
Type Parameters
- TSecond
- TResult
Parameters
- second: IAsyncParallel<TSecond>
- resultSelector: (x: TSource, y: TSecond) => TResult
Returns IParallelEnumerable<TResult>
- Defined in src/types/IParallelEnumerable.ts:266
zip<TSecond>(
second: IAsyncParallel<TSecond>,
): IParallelEnumerable<[TSource, TSecond]>
Type Parameters
- TSecond
Parameters
- second: IAsyncParallel<TSecond>
Returns IParallelEnumerable<[TSource, TSecond]>
- Defined in src/types/IParallelEnumerable.ts:269

zipAsync

zipAsync<TSecond, TResult>(
second: IAsyncParallel<TSecond>,
resultSelector: (x: TSource, y: TSecond) => Promise<TResult>,
): IParallelEnumerable<TResult>
Type Parameters
- TSecond
- TResult
Parameters
- second: IAsyncParallel<TSecond>
- resultSelector: (x: TSource, y: TSecond) => Promise<TResult>
Returns IParallelEnumerable<TResult>
- Defined in src/types/IParallelEnumerable.ts:271

Interface IParallelEnumerable<TSource>

Type Parameters

Hierarchy (View Summary)

Index

Properties

Methods

Properties

ReadonlydataFunc

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>

append

Parameters

Returns IParallelEnumerable<TSource>

asAsync

Returns IAsyncEnumerable<TSource>

See

average

Parameters

Returns Promise<number>

Throws

Parameters

Returns Promise<number>

Throws

averageAsync

Parameters

Returns Promise<number>

Throws

chunk

Parameters

Returns IParallelEnumerable<TSource[]>

concatenate

Parameters

Returns IParallelEnumerable<TSource>

contains

Parameters

Returns Promise<boolean>

containsAsync

Parameters

Returns Promise<boolean>

count

Parameters

Returns Promise<number>

countAsync

Parameters

Returns Promise<number>

defaultIfEmpty

Parameters

Returns IParallelEnumerable<TSource>

distinct

Parameters

Returns IParallelEnumerable<TSource>

distinctAsync

Parameters

Returns IParallelEnumerable<TSource>

each

Parameters

Returns IParallelEnumerable<TSource>

eachAsync

`Readonly`dataFunc