Interface IGrouping<TKey, TElement>

Represents a grouping based on a key

interface IGrouping {
    key: TKey;
    [iterator](): IterableIterator<TElement>;
    aggregate(func): TElement;
    aggregate<TAccumulate>(seed, func): TAccumulate;
    aggregate<TAccumulate, TResult>(seed, func, resultSelector): TResult;
    all(predicate): boolean;
    allAsync(predicate): Promise<boolean>;
    any(predicate?): boolean;
    anyAsync(predicate): Promise<boolean>;
    append(element): IEnumerable<TElement>;
    asAsync(): IAsyncEnumerable<TElement>;
    asParallel(): IParallelEnumerable<TElement>;
    average(this): number;
    average(selector): number;
    averageAsync(selector): Promise<number>;
    chunk(size): IEnumerable<TElement[]>;
    concatenate(second): IEnumerable<TElement>;
    contains(value, comparer?): boolean;
    containsAsync(value, comparer): Promise<boolean>;
    count(predicate?): number;
    countAsync(predicate): Promise<number>;
    defaultIfEmpty(defaultValue): IEnumerable<TElement>;
    distinct(comparer?): IEnumerable<TElement>;
    distinctAsync(comparer): IAsyncEnumerable<TElement>;
    each(action): IEnumerable<TElement>;
    eachAsync(action): IAsyncEnumerable<TElement>;
    elementAt(index): TElement;
    elementAtOrDefault(index): null | TElement;
    except(second, comparer?): IEnumerable<TElement>;
    exceptAsync(second, comparer): IAsyncEnumerable<TElement>;
    first(predicate?): TElement;
    firstAsync(predicate): Promise<TElement>;
    firstOrDefault(predicate?): null | TElement;
    firstOrDefaultAsync(predicate): Promise<null | TElement>;
    groupBy<TKey>(keySelector): IEnumerable<IGrouping<TKey, TElement>>;
    groupBy<TKey>(keySelector, comparer): IEnumerable<IGrouping<TKey, TElement>>;
    groupByAsync<TKey>(keySelector): IAsyncEnumerable<IGrouping<TKey, TElement>>;
    groupByAsync<TKey>(keySelector, comparer): IAsyncEnumerable<IGrouping<TKey, TElement>>;
    groupByWithSel<TElement, TKey>(keySelector, elementSelector): IEnumerable<IGrouping<TKey, TElement>>;
    groupByWithSel<TKey, TElement>(keySelector, elementSelector, comparer): IEnumerable<IGrouping<TKey, TElement>>;
    groupJoin<TInner, TKey, TResult>(inner, outerKeySelector, innerKeySelector, resultSelector, comparer?): IEnumerable<TResult>;
    groupJoinAsync<TInner, TKey, TResult>(inner, outerKeySelector, innerKeySelector, resultSelector, comparer?): IAsyncEnumerable<TResult>;
    intersect(second, comparer?): IEnumerable<TElement>;
    intersectAsync(second, comparer): IAsyncEnumerable<TElement>;
    joinByKey<TInner, TKey, TResult>(inner, outerKeySelector, innerKeySelector, resultSelector, comparer?): IEnumerable<TResult>;
    last(predicate?): TElement;
    lastAsync(predicate): Promise<TElement>;
    lastOrDefault(predicate?): null | TElement;
    lastOrDefaultAsync(predicate): Promise<null | TElement>;
    max(this): number;
    max(selector): number;
    maxAsync(selector): Promise<number>;
    min(this): number;
    min(selector): number;
    minAsync(selector): Promise<number>;
    ofType<T>(type): IEnumerable<InferType<T>>;
    order(comparer?): IOrderedEnumerable<TElement>;
    orderBy<TKey>(predicate, comparer?): IOrderedEnumerable<TElement>;
    orderByAsync<TKey>(predicate, comparer?): IOrderedAsyncEnumerable<TElement>;
    orderByDescending<TKey>(predicate, comparer?): IOrderedEnumerable<TElement>;
    orderByDescendingAsync<TKey>(predicate, comparer?): IOrderedAsyncEnumerable<TElement>;
    orderDescending(comparer?): IOrderedEnumerable<TElement>;
    partition(predicate): [pass: TElement[], fail: TElement[]];
    partitionAsync(predicate): Promise<[pass: TElement[], fail: TElement[]]>;
    prepend(element): IEnumerable<TElement>;
    reverse(): IEnumerable<TElement>;
    select<TResult>(selector): IEnumerable<TResult>;
    select<TKey>(key): IEnumerable<TElement[TKey]>;
    selectAsync<TResult>(selector): IAsyncEnumerable<TResult>;
    selectAsync<TKey, TResult>(this, key): IAsyncEnumerable<TResult>;
    selectMany<TResult>(selector): IEnumerable<TResult>;
    selectMany<TBindedSource, TOut>(this, selector): IEnumerable<TOut>;
    selectManyAsync<TResult>(selector): IAsyncEnumerable<TResult>;
    sequenceEquals(second, comparer?): boolean;
    sequenceEqualsAsync(second, comparer): Promise<boolean>;
    single(predicate?): TElement;
    singleAsync(predicate): Promise<TElement>;
    singleOrDefault(predicate?): null | TElement;
    singleOrDefaultAsync(predicate): Promise<null | TElement>;
    skip(count): IEnumerable<TElement>;
    skipWhile(predicate): IEnumerable<TElement>;
    skipWhileAsync(predicate): IAsyncEnumerable<TElement>;
    sum(this): number;
    sum(selector): number;
    sumAsync(selector): Promise<number>;
    take(amount): IEnumerable<TElement>;
    takeWhile(predicate): IEnumerable<TElement>;
    takeWhileAsync(predicate): IAsyncEnumerable<TElement>;
    toArray(): TElement[];
    toMap<TKey>(selector): Map<TKey, TElement[]>;
    toMapAsync<TKey>(selector): Promise<Map<TKey, TElement[]>>;
    toObject<TKey>(selector): Record<TKey, TElement>;
    toObjectAsync<TKey>(selector): Promise<Record<TKey, TElement>>;
    toSet(): Set<TElement>;
    union(second, comparer?): IEnumerable<TElement>;
    unionAsync(second, comparer): IAsyncEnumerable<TElement>;
    where(predicate): IEnumerable<TElement>;
    whereAsync(predicate): IAsyncEnumerable<TElement>;
    zip<TSecond>(second): IEnumerable<[TElement, TSecond]>;
    zip<TSecond, TResult>(second, resultSelector): IEnumerable<TResult>;
    zipAsync<TSecond, TResult>(second, resultSelector): IAsyncEnumerable<TResult>;
}

Type Parameters

TKey
TElement

Hierarchy

IEnumerable<TElement>
- IGrouping

Index

Properties

key

Methods

[iterator] aggregate all allAsync any anyAsync append asAsync asParallel 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` key

key: TKey

Methods

[iterator]

[iterator](): IterableIterator<TElement>
Returns IterableIterator<TElement>
Inherited from IEnumerable.[iterator]
- Defined in src/types/IEnumerable.ts:796

aggregate

aggregate(func): TElement
Applies an accumulator function over a sequence.
Parameters
- func: ((x, y) => TElement)
  An accumulator function to be invoked on each element.
  - - (x, y): TElement
    - Parameters
      x: TElement
      y: TElement
      Returns TElement
Returns TElement
The final accumulator value.
Inherited from IEnumerable.aggregate
- Defined in src/types/IEnumerable.ts:24
aggregate<TAccumulate>(seed, func): 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, y) => TAccumulate)
  An accumulator function to be invoked on each element.
  - - (x, y): TAccumulate
    - Parameters
      x: TAccumulate
      y: TElement
      Returns TAccumulate
Returns TAccumulate
The final accumulator value.
Inherited from IEnumerable.aggregate
- Defined in src/types/IEnumerable.ts:32
aggregate<TAccumulate, TResult>(seed, func, resultSelector): 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, y) => TAccumulate)
  An accumulator function to be invoked on each element.
  - - (x, y): TAccumulate
    - Parameters
      x: TAccumulate
      y: TElement
      Returns TAccumulate
- resultSelector: ((x) => TResult)
  A function to transform the final accumulator value into the result value.
  - - (x): TResult
    - Parameters
      x: TAccumulate
      Returns TResult
Returns TResult
The transformed final accumulator value.
Inherited from IEnumerable.aggregate
- Defined in src/types/IEnumerable.ts:42

all

all(predicate): boolean
Determines whether all elements of a sequence satisfy a condition.
Parameters
- predicate: ((x) => boolean)
  A function to test each element for a condition.
  - - (x): boolean
    - Parameters
      x: TElement
      Returns boolean
Returns 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 IEnumerable.all
- Defined in src/types/IEnumerable.ts:52

allAsync

allAsync(predicate): Promise<boolean>
Determines whether all elements of a sequence satisfy a condition.
Parameters
- predicate: ((x) => Promise<boolean>)
  An async function to test each element for a condition.
  - - (x): Promise<boolean>
    - Parameters
      x: TElement
      Returns Promise<boolean>
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 IEnumerable.allAsync
- Defined in src/types/IEnumerable.ts:59

any

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

anyAsync

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

append

append(element): IEnumerable<TElement>
Appends a value to the end of the sequence.
Parameters
- element: TElement
  The value to append to the sequence.
Returns IEnumerable<TElement>
An IEnumerable that ends with the specified element.
Inherited from IEnumerable.append
- Defined in src/types/IEnumerable.ts:78

asAsync

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

Returns IAsyncEnumerable<TElement>
An IAsyncEnumerable

See
Inherited from IEnumerable.asAsync
- Defined in src/types/IEnumerable.ts:83

asParallel

asParallel(): IParallelEnumerable<TElement>
Converts an iterable to

Returns IParallelEnumerable<TElement>
An IParallelEnumerable

See
Inherited from IEnumerable.asParallel
- Defined in src/types/IEnumerable.ts:88

average

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

Throws
source contains no elements.
Inherited from IEnumerable.average
- Defined in src/types/IEnumerable.ts:94
average(selector): 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) => number)
  A transform function to apply to each element.
  - - (x): number
    - Parameters
      x: TElement
      Returns number
Returns number
The average of the sequence of values.

Throws
source contains no elements.
Inherited from IEnumerable.average
- Defined in src/types/IEnumerable.ts:102

averageAsync

averageAsync(selector): 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) => Promise<number>)
  An async transform function to apply to each element.
  - - (x): Promise<number>
    - Parameters
      x: TElement
      Returns Promise<number>
Returns Promise<number>
The average of the sequence of values.

Throws
source contains no elements.
Inherited from IEnumerable.averageAsync
- Defined in src/types/IEnumerable.ts:110

chunk

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

concatenate

concatenate(second): IEnumerable<TElement>
Concatenates two sequences.
Parameters
- second: IEnumerable<TElement>
  The sequence to concatenate to the first sequence.
Returns IEnumerable<TElement>
An IEnumerable that contains the concatenated elements of the two sequences.
Inherited from IEnumerable.concatenate
- Defined in src/types/IEnumerable.ts:122

contains

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

containsAsync

containsAsync(value, comparer): Promise<boolean>
Determines whether a sequence contains a specified element by using the specified or default IEqualityComparer.
Parameters
- value: TElement
  The value to locate in the sequence.
- comparer: IAsyncEqualityComparer<TElement>
  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 IEnumerable.containsAsync
- Defined in src/types/IEnumerable.ts:138

count

count(predicate?): 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
- Optional predicate: ((x) => boolean)
  A function to test each element for a condition. Optional.
  - - (x): boolean
    - Parameters
      x: TElement
      Returns boolean
Returns number
The number of elements in the input sequence.
Inherited from IEnumerable.count
- Defined in src/types/IEnumerable.ts:146

countAsync

countAsync(predicate): 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) => Promise<boolean>)
  A function to test each element for a condition.
  - - (x): Promise<boolean>
    - Parameters
      x: TElement
      Returns Promise<boolean>
Returns Promise<number>
The number of elements in the input sequence.
Inherited from IEnumerable.countAsync
- Defined in src/types/IEnumerable.ts:154

defaultIfEmpty

defaultIfEmpty(defaultValue): IEnumerable<TElement>
Returns the elements of an IEnumerable, or a default valued singleton collection if the sequence is empty.
Parameters
- defaultValue: TElement
  The value to return if the sequence is empty.
Returns IEnumerable<TElement>
An IEnumerable that contains defaultValue if source is empty; otherwise, source.
Inherited from IEnumerable.defaultIfEmpty
- Defined in src/types/IEnumerable.ts:160

distinct

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

distinctAsync

distinctAsync(comparer): IAsyncEnumerable<TElement>
Returns distinct elements from a sequence by using the specified equality comparer to compare values.
Parameters
- comparer: IAsyncEqualityComparer<TElement>
  An IAsyncEqualityComparer to compare values.
Returns IAsyncEnumerable<TElement>
An IAsyncEnumerable that contains distinct elements from the source sequence.
Inherited from IEnumerable.distinctAsync
- Defined in src/types/IEnumerable.ts:172

each

each(action): IEnumerable<TElement>
Performs a specified action on each element of the Iterable
Parameters
- action: ((x) => void)
  The action to take an each element
  - - (x): void
    - Parameters
      x: TElement
      Returns void
Returns IEnumerable<TElement>
A new IEnumerable that executes the action lazily as you iterate.
Inherited from IEnumerable.each
- Defined in src/types/IEnumerable.ts:244

eachAsync

eachAsync(action): IAsyncEnumerable<TElement>
Performs a specified action on each element of the Iterable
Parameters
- action: ((x) => Promise<void>)
  The async action to take an each element
  - - (x): Promise<void>
    - Parameters
      x: TElement
      Returns Promise<void>
Returns IAsyncEnumerable<TElement>
A new IAsyncEnumerable that executes the action lazily as you iterate.
Inherited from IEnumerable.eachAsync
- Defined in src/types/IEnumerable.ts:250

elementAt

elementAt(index): TElement
Returns the element at a specified index in a sequence.
Parameters
- index: number
  The zero-based index of the element to retrieve.
Returns TElement
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 IEnumerable.elementAt
- Defined in src/types/IEnumerable.ts:180

elementAtOrDefault

elementAtOrDefault(index): null | TElement
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 null | TElement
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 IEnumerable.elementAtOrDefault
- Defined in src/types/IEnumerable.ts:188

except

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

exceptAsync

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

first

first(predicate?): TElement
Returns first element in sequence that satisfies predicate otherwise returns the first element in the sequence.
Parameters
- Optional predicate: ((x) => boolean)
  A function to test each element for a condition. Optional.
  - - (x): boolean
    - Parameters
      x: TElement
      Returns boolean
Returns TElement
The first element in the sequence or the first element that passes the test in the specified predicate function.

Throws
No elements in Iteration matching predicate
Inherited from IEnumerable.first
- Defined in src/types/IEnumerable.ts:214

firstAsync

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

Throws
No elements in Iteration matching predicate
Inherited from IEnumerable.firstAsync
- Defined in src/types/IEnumerable.ts:221

firstOrDefault

firstOrDefault(predicate?): null | TElement
Returns first element in sequence that satisfies predicate otherwise returns the first element in the sequence. Returns null if no value found.
Parameters
- Optional predicate: ((x) => boolean)
  A function to test each element for a condition. Optional.
  - - (x): boolean
    - Parameters
      x: TElement
      Returns boolean
Returns null | TElement
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 IEnumerable.firstOrDefault
- Defined in src/types/IEnumerable.ts:230

firstOrDefaultAsync

firstOrDefaultAsync(predicate): Promise<null | TElement>
Returns the first element of the sequence that satisfies a condition or a default value if no such element is found.
Parameters
- predicate: ((x) => Promise<boolean>)
  An async function to test each element for a condition.
  - - (x): Promise<boolean>
    - Parameters
      x: TElement
      Returns Promise<boolean>
Returns Promise<null | TElement>
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 IEnumerable.firstOrDefaultAsync
- Defined in src/types/IEnumerable.ts:238

groupBy

groupBy<TKey>(keySelector): IEnumerable<IGrouping<TKey, TElement>>
Groups the elements of a sequence according to a specified key selector function.
Type Parameters
- TKey extends SelectorKeyType
Parameters
- keySelector: ((x) => TKey)
  A function to extract the key for each element.
  - - (x): TKey
    - Parameters
      x: TElement
      Returns TKey
Returns IEnumerable<IGrouping<TKey, TElement>>
An IEnumerable<IGrouping<TKey, TSource>> where each IGrouping<TKey,TElement> object contains a sequence of objects and a key.
Inherited from IEnumerable.groupBy
- Defined in src/types/IEnumerable.ts:257
groupBy<TKey>(keySelector, comparer): IEnumerable<IGrouping<TKey, TElement>>
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) => TKey)
  A function to extract the key for each element.
  - - (x): TKey
    - Parameters
      x: TElement
      Returns TKey
- comparer: IEqualityComparer<TKey>
  An IEqualityComparer to compare keys.
Returns IEnumerable<IGrouping<TKey, TElement>>
An IEnumerable<IGrouping<TKey, TSource>> where each IGrouping<TKey,TElement> object contains a sequence of objects and a key.
Inherited from IEnumerable.groupBy
- Defined in src/types/IEnumerable.ts:267

groupByAsync

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

groupByWithSel

groupByWithSel<TElement, TKey>(keySelector, elementSelector): IEnumerable<IGrouping<TKey, TElement>>
Groups the elements of a sequence according to a specified key selector function and projects the elements for each group by using a specified function.
Type Parameters
- TElement
- TKey extends SelectorKeyType
Parameters
- keySelector: ((x) => TKey)
  A function to extract the key for each element.
  - - (x): TKey
    - Parameters
      x: TElement
      Returns TKey
- elementSelector: ((x) => TElement)
  A function to map each source element to an element in an IGrouping<TKey,TElement>.
  - - (x): TElement
    - Parameters
      x: TElement
      Returns TElement
Returns IEnumerable<IGrouping<TKey, TElement>>
An IEnumerable<IGrouping<TKey, TElement>> where each IGrouping<TKey,TElement> object contains a collection of objects of type TElement and a key.
Inherited from IEnumerable.groupByWithSel
- Defined in src/types/IEnumerable.ts:297
groupByWithSel<TKey, TElement>(keySelector, elementSelector, comparer): IEnumerable<IGrouping<TKey, TElement>>
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
- TElement
Parameters
- keySelector: ((x) => TKey)
  A function to extract the key for each element.
  - - (x): TKey
    - Parameters
      x: TElement
      Returns TKey
- elementSelector: ((x) => TElement)
  A function to map each source element to an element in an IGrouping<TKey,TElement>.
  - - (x): TElement
    - Parameters
      x: TElement
      Returns TElement
- comparer: IEqualityComparer<TKey>
  An IEqualityComparer to compare keys.
Returns IEnumerable<IGrouping<TKey, TElement>>
An IEnumerable<IGrouping<TKey,TElement>> where each IGrouping<TKey,TElement> object contains a collection of objects of type TElement and a key.
Inherited from IEnumerable.groupByWithSel
- Defined in src/types/IEnumerable.ts:309

groupJoin

groupJoin<TInner, TKey, TResult>(inner, outerKeySelector, innerKeySelector, resultSelector, comparer?): IEnumerable<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>
  The sequence to join to the first sequence.
- outerKeySelector: ((value) => TKey)
  The sequence to join to the first sequence.
  - - (value): TKey
    - Parameters
      value: TElement
      Returns TKey
- innerKeySelector: ((value) => TKey)
  A function to extract the join key from each element of the second sequence.
  - - (value): TKey
    - Parameters
      value: TInner
      Returns TKey
- resultSelector: ((element, collection) => 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.
  - - (element, collection): TResult
    - Parameters
      element: TElement
      collection: TInner[]
      Returns TResult
- Optional comparer: IEqualityComparer<TKey>
  To compare keys. Optional.
Returns IEnumerable<TResult>
An IEnumerable that contains elements of type TResult that are obtained by performing a grouped join on two sequences.
Inherited from IEnumerable.groupJoin
- Defined in src/types/IEnumerable.ts:322

groupJoinAsync

groupJoinAsync<TInner, TKey, TResult>(inner, outerKeySelector, innerKeySelector, resultSelector, comparer?): IAsyncEnumerable<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>
  The sequence to join to the first sequence. Can be async.
- outerKeySelector: ((value) => TKey | Promise<TKey>)
  The sequence to join to the first sequence. Can be async.
  - - (value): TKey | Promise<TKey>
    - Parameters
      value: TElement
      Returns TKey | Promise<TKey>
- innerKeySelector: ((value) => TKey | Promise<TKey>)
  A function to extract the join key from each element of the second sequence.
  - - (value): TKey | Promise<TKey>
    - Parameters
      value: TInner
      Returns TKey | Promise<TKey>
- resultSelector: ((element, collection) => 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.
  - - (element, collection): TResult | Promise<TResult>
    - Parameters
      element: TElement
      collection: TInner[]
      Returns TResult | Promise<TResult>
- Optional comparer: IEqualityComparer<TKey>
  To compare keys. Optional.
Returns IAsyncEnumerable<TResult>
An IAsyncEnumerable that contains elements of type TResult that are obtained by performing a grouped join on two sequences.
Inherited from IEnumerable.groupJoinAsync
- Defined in src/types/IEnumerable.ts:337

intersect

intersect(second, comparer?): IEnumerable<TElement>
Produces the set intersection of two sequences by using the specified IEqualityComparer to compare values. If no comparer is selected, uses the StrictEqualityComparer.
Parameters
- second: IEnumerable<TElement>
  An Iterable whose distinct elements that also appear in the first sequence will be returned.
- Optional comparer: IEqualityComparer<TElement>
  An IEqualityComparer to compare values. Optional.
Returns IEnumerable<TElement>
A sequence that contains the elements that form the set intersection of two sequences.
Inherited from IEnumerable.intersect
- Defined in src/types/IEnumerable.ts:350

intersectAsync

intersectAsync(second, comparer): IAsyncEnumerable<TElement>
Produces the set intersection of two sequences by using the specified IAsyncEqualityComparer to compare values.
Parameters
- second: IEnumerable<TElement>
  An Iterable whose distinct elements that also appear in the first sequence will be returned.
- comparer: IAsyncEqualityComparer<TElement>
  An IAsyncEqualityComparer to compare values.
Returns IAsyncEnumerable<TElement>
A sequence that contains the elements that form the set intersection of two sequences.
Inherited from IEnumerable.intersectAsync
- Defined in src/types/IEnumerable.ts:358

joinByKey

joinByKey<TInner, TKey, TResult>(inner, outerKeySelector, innerKeySelector, resultSelector, comparer?): IEnumerable<TResult>
Correlates the elements of two sequences based on matching keys. A specified IEqualityComparer is used to compare keys or the strict equality comparer.
Type Parameters
- TInner
- TKey
- TResult
Parameters
- inner: IEnumerable<TInner>
  The sequence to join to the first sequence.
- outerKeySelector: ((x) => TKey)
  A function to extract the join key from each element of the first sequence.
  - - (x): TKey
    - Parameters
      x: TElement
      Returns TKey
- innerKeySelector: ((x) => TKey)
  A function to extract the join key from each element of the second sequence.
  - - (x): TKey
    - Parameters
      x: TInner
      Returns TKey
- resultSelector: ((x, y) => TResult)
  A function to create a result element from two matching elements.
  - - (x, y): TResult
    - Parameters
      x: TElement
      y: TInner
      Returns TResult
- Optional comparer: IEqualityComparer<TKey>
  An IEqualityComparer to hash and compare keys. Optional.
Returns IEnumerable<TResult>
An IEnumerable that has elements of type TResult that are obtained by performing an inner join on two sequences.
Inherited from IEnumerable.joinByKey
- Defined in src/types/IEnumerable.ts:372

last

last(predicate?): TElement
Returns the last element of a sequence. If predicate is specified, the last element of a sequence that satisfies a specified condition.
Parameters
- Optional predicate: ((x) => boolean)
  A function to test each element for a condition. Optional.
  - - (x): boolean
    - Parameters
      x: TElement
      Returns boolean
Returns TElement
The value at the last position in the source sequence or the last element in the sequence that passes the test in the specified predicate function.

Throws
The source sequence is empty.
Inherited from IEnumerable.last
- Defined in src/types/IEnumerable.ts:386

lastAsync

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

Throws
The source sequence is empty.
Inherited from IEnumerable.lastAsync
- Defined in src/types/IEnumerable.ts:393

lastOrDefault

lastOrDefault(predicate?): null | TElement
Returns the last element of a sequence. If predicate is specified, the last element of a sequence that satisfies a specified condition.
Parameters
- Optional predicate: ((x) => boolean)
  A function to test each element for a condition. Optional.
  - - (x): boolean
    - Parameters
      x: TElement
      Returns boolean
Returns null | TElement
The value at the last position in the source sequence or the last element in the sequence that passes the test in the specified predicate function.
Inherited from IEnumerable.lastOrDefault
- Defined in src/types/IEnumerable.ts:401

lastOrDefaultAsync

lastOrDefaultAsync(predicate): Promise<null | TElement>
Returns the last element of a sequence that satisfies a specified condition.
Parameters
- predicate: ((x) => Promise<boolean>)
  A function to test each element for a condition.
  - - (x): Promise<boolean>
    - Parameters
      x: TElement
      Returns Promise<boolean>
Returns Promise<null | TElement>
The last element in the sequence that passes the test in the specified predicate function. Null if no elements.
Inherited from IEnumerable.lastOrDefaultAsync
- Defined in src/types/IEnumerable.ts:408

max

max(this): number
Returns the maximum value in a sequence of values.
Parameters
- this: IEnumerable<number>
Returns number
The maximum value in the sequence.

Throws
source contains no elements.
Inherited from IEnumerable.max
- Defined in src/types/IEnumerable.ts:414
max(selector): number
Invokes a transform function on each element of a sequence and returns the maximum value.
Parameters
- selector: ((x) => number)
  A transform function to apply to each element.
  - - (x): number
    - Parameters
      x: TElement
      Returns number
Returns number
The maximum value in the sequence.

Throws
source contains no elements.
Inherited from IEnumerable.max
- Defined in src/types/IEnumerable.ts:421

maxAsync

maxAsync(selector): Promise<number>
Invokes an async transform function on each element of a sequence and returns the maximum value.
Parameters
- selector: ((x) => Promise<number>)
  A transform function to apply to each element.
  - - (x): Promise<number>
    - Parameters
      x: TElement
      Returns Promise<number>
Returns Promise<number>
The maximum value in the sequence.

Throws
source contains no elements.
Inherited from IEnumerable.maxAsync
- Defined in src/types/IEnumerable.ts:428

min

min(this): number
Returns the minimum value in a sequence of values.
Parameters
- this: IEnumerable<number>
Returns number
The minimum value in the sequence.

Throws
source contains no elements.
Inherited from IEnumerable.min
- Defined in src/types/IEnumerable.ts:434
min(selector): number
Invokes a transform function on each element of a sequence and returns the minimum value.
Parameters
- selector: ((x) => number)
  A transform function to apply to each element.
  - - (x): number
    - Parameters
      x: TElement
      Returns number
Returns number
The minimum value in the sequence.

Throws
source contains no elements.
Inherited from IEnumerable.min
- Defined in src/types/IEnumerable.ts:441

minAsync

minAsync(selector): Promise<number>
Invokes a transform function on each element of a sequence and returns the minimum value.
Parameters
- selector: ((x) => Promise<number>)
  A transform function to apply to each element.
  - - (x): Promise<number>
    - Parameters
      x: TElement
      Returns Promise<number>
Returns Promise<number>
The minimum value in the sequence.

Throws
source contains no elements.
Inherited from IEnumerable.minAsync
- Defined in src/types/IEnumerable.ts:448

ofType

ofType<T>(type): IEnumerable<InferType<T>>
Applies a type filter to a source iteration
Type Parameters
- T extends OfType
Parameters
- type: T
  Either value for typeof or a consturctor function
Returns IEnumerable<InferType<T>>
Values that match the type string or are instance of type
Inherited from IEnumerable.ofType
- Defined in src/types/IEnumerable.ts:454

order

order(comparer?): IOrderedEnumerable<TElement>
Sorts the elements of a sequence in ascending order by using a specified or default comparer.
Parameters
- Optional comparer: IComparer<TElement>
  An IComparer to compare values. Optional.
Returns IOrderedEnumerable<TElement>
An IOrderedEnumerable whose elements are sorted.
Inherited from IEnumerable.order
- Defined in src/types/IEnumerable.ts:460

orderBy

orderBy<TKey>(predicate, comparer?): IOrderedEnumerable<TElement>
Sorts the elements of a sequence in ascending order by using a specified or default comparer.
Type Parameters
- TKey
Parameters
- predicate: ((x) => TKey)
  A function to extract a key from an element.
  - - (x): TKey
    - Parameters
      x: TElement
      Returns TKey
- Optional comparer: IComparer<TKey>
  An IComparer to compare keys. Optional.
Returns IOrderedEnumerable<TElement>
An IOrderedEnumerable whose elements are sorted according to a key.
Inherited from IEnumerable.orderBy
- Defined in src/types/IEnumerable.ts:468

orderByAsync

orderByAsync<TKey>(predicate, comparer?): IOrderedAsyncEnumerable<TElement>
Sorts the elements of a sequence in ascending order by using a specified comparer.
Type Parameters
- TKey
Parameters
- predicate: ((x) => Promise<TKey>)
  An async function to extract a key from an element.
  - - (x): Promise<TKey>
    - Parameters
      x: TElement
      Returns Promise<TKey>
- Optional comparer: IComparer<TKey>
  An IComparer to compare keys.
Returns IOrderedAsyncEnumerable<TElement>
An IOrderedAsyncEnumerable whose elements are sorted according to a key.
Inherited from IEnumerable.orderByAsync
- Defined in src/types/IEnumerable.ts:477

orderByDescending

orderByDescending<TKey>(predicate, comparer?): IOrderedEnumerable<TElement>
Sorts the elements of a sequence in descending order by using a specified or default comparer.
Type Parameters
- TKey
Parameters
- predicate: ((x) => TKey)
  A function to extract a key from an element.
  - - (x): TKey
    - Parameters
      x: TElement
      Returns TKey
- Optional comparer: IComparer<TKey>
  An IComparer to compare keys. Optional.
Returns IOrderedEnumerable<TElement>
An IOrderedEnumerable whose elements are sorted in descending order according to a key.
Inherited from IEnumerable.orderByDescending
- Defined in src/types/IEnumerable.ts:486

orderByDescendingAsync

orderByDescendingAsync<TKey>(predicate, comparer?): IOrderedAsyncEnumerable<TElement>
Sorts the elements of a sequence in descending order by using a specified comparer.
Type Parameters
- TKey
Parameters
- predicate: ((x) => Promise<TKey>)
  An async function to extract a key from an element.
  - - (x): Promise<TKey>
    - Parameters
      x: TElement
      Returns Promise<TKey>
- Optional comparer: IComparer<TKey>
  An IComparer to compare keys.
Returns IOrderedAsyncEnumerable<TElement>
An IOrderedAsyncEnumerable whose elements are sorted in descending order according to a key.
Inherited from IEnumerable.orderByDescendingAsync
- Defined in src/types/IEnumerable.ts:495

orderDescending

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

partition

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

partitionAsync

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

prepend

prepend(element): IEnumerable<TElement>
Adds a value to the beginning of the sequence.
Parameters
- element: TElement
  The value to prepend to the sequence.
Returns IEnumerable<TElement>
An IEnumerable that begins with the specified element.
Inherited from IEnumerable.prepend
- Defined in src/types/IEnumerable.ts:522

reverse

reverse(): IEnumerable<TElement>
Inverts the order of the elements in a sequence.

Returns IEnumerable<TElement>
A sequence whose elements correspond to those of the input sequence in reverse order.
Inherited from IEnumerable.reverse
- Defined in src/types/IEnumerable.ts:527

select

select<TResult>(selector): IEnumerable<TResult>
Projects each element of a sequence into a new form.
Type Parameters
- TResult
Parameters
- selector: ((x, index) => TResult)
  A transform function to apply to each element.
  - - (x, index): TResult
    - Parameters
      x: TElement
      index: number
      Returns TResult
Returns IEnumerable<TResult>
An IEnumerable whose elements are the result of invoking the transform function on each element of source.
Inherited from IEnumerable.select
- Defined in src/types/IEnumerable.ts:534
select<TKey>(key): IEnumerable<TElement[TKey]>
Projects each element of a sequence into a new form.
Type Parameters
- TKey extends string | number | symbol
Parameters
- key: TKey
  A key of TSource.
Returns IEnumerable<TElement[TKey]>
An IEnumerable whose elements are the result of getting the value from the key on each element of source.
Inherited from IEnumerable.select
- Defined in src/types/IEnumerable.ts:541

selectAsync

selectAsync<TResult>(selector): IAsyncEnumerable<TResult>
Projects each element of a sequence into a new form.
Type Parameters
- TResult
Parameters
- selector: ((x, index) => Promise<TResult>)
  An async transform function to apply to each element.
  - - (x, index): Promise<TResult>
    - Parameters
      x: TElement
      index: number
      Returns Promise<TResult>
Returns IAsyncEnumerable<TResult>
An IAsyncEnumerable whose elements are the result of invoking the transform function on each element of source.
Inherited from IEnumerable.selectAsync
- Defined in src/types/IEnumerable.ts:548
selectAsync<TKey, TResult>(this, key): IAsyncEnumerable<TResult>
Projects each element of a sequence into a new form.
Type Parameters
- TKey extends string | number | symbol
- TResult
Parameters
- this: IEnumerable<{
  [key: string]: Promise<TResult>;
  }>
- key: TKey
  A key of the elements in the sequence
Returns IAsyncEnumerable<TResult>
An IAsyncEnumerable whoe elements are the result of getting the value for key on each element of source.
Inherited from IEnumerable.selectAsync
- Defined in src/types/IEnumerable.ts:555

selectMany

selectMany<TResult>(selector): IEnumerable<TResult>
Projects each element of a sequence to an IEnumerable and flattens the resulting sequences into one sequence.
Type Parameters
- TResult
Parameters
- selector: ((x, index) => Iterable<TResult>)
  A transform function to apply to each element.
  - - (x, index): Iterable<TResult>
    - Parameters
      x: TElement
      index: number
      Returns Iterable<TResult>
Returns IEnumerable<TResult>
An IEnumerable whose elements are the result of invoking the one-to-many transform function on each element of the input sequence.
Inherited from IEnumerable.selectMany
- Defined in src/types/IEnumerable.ts:564
selectMany<TBindedSource, TOut>(this, selector): IEnumerable<TOut>
Projects each element of a sequence to an IEnumerable and flattens the resulting sequences into one sequence.
Type Parameters
- TBindedSource extends {
  [key: string]: Iterable<TOut>;
  }
- TOut
Parameters
- this: IEnumerable<TBindedSource>
- selector: keyof TBindedSource
  A string key of TSource.
Returns IEnumerable<TOut>
An IEnumerable whose elements are the result of invoking the parameter the key is tried to on each element of the input sequence.
Inherited from IEnumerable.selectMany
- Defined in src/types/IEnumerable.ts:571

selectManyAsync

selectManyAsync<TResult>(selector): IAsyncEnumerable<TResult>
Projects each element of a sequence to an IAsyncEnumerable and flattens the resulting sequences into one sequence.
Type Parameters
- TResult
Parameters
- selector: ((x, index) => Promise<Iterable<TResult>>)
  A transform function to apply to each element.
  - - (x, index): Promise<Iterable<TResult>>
    - Parameters
      x: TElement
      index: number
      Returns Promise<Iterable<TResult>>
Returns IAsyncEnumerable<TResult>
An IAsyncEnumerable whose elements are the result of invoking the one-to-many transform function on each element of the input sequence.
Inherited from IEnumerable.selectManyAsync
- Defined in src/types/IEnumerable.ts:581

sequenceEquals

sequenceEquals(second, comparer?): boolean
Determines whether or not two sequences are equal
Parameters
- second: IEnumerable<TElement>
  second iterable
- Optional comparer: IEqualityComparer<TElement>
  Compare function to use, by default is
Returns boolean
Whether or not the two iterations are equal

See
Inherited from IEnumerable.sequenceEquals
- Defined in src/types/IEnumerable.ts:589

sequenceEqualsAsync

sequenceEqualsAsync(second, comparer): Promise<boolean>
Compares two sequences to see if they are equal using an async comparer function.
Parameters
- second: IEnumerable<TElement>
  Second Sequence
- comparer: IAsyncEqualityComparer<TElement>
  Async Comparer
Returns Promise<boolean>
Whether or not the two iterations are equal
Inherited from IEnumerable.sequenceEqualsAsync
- Defined in src/types/IEnumerable.ts:596

single

single(predicate?): TElement
Returns the only element of a sequence that satisfies a specified condition (if specified), and throws an exception if more than one such element exists.
Parameters
- Optional predicate: ((x) => boolean)
  A function to test an element for a condition. (Optional)
  - - (x): boolean
    - Parameters
      x: TElement
      Returns boolean
Returns TElement
The single element of the input sequence that satisfies a condition.

Throws
No element satisfies the condition in predicate. OR More than one element satisfies the condition in predicate. OR The source sequence is empty.
Inherited from IEnumerable.single
- Defined in src/types/IEnumerable.ts:606

singleAsync

singleAsync(predicate): Promise<TElement>
Returns the only element of a sequence that satisfies a specified condition, and throws an exception if more than one such element exists.
Parameters
- predicate: ((x) => Promise<boolean>)
  A function to test an element for a condition.
  - - (x): Promise<boolean>
    - Parameters
      x: TElement
      Returns Promise<boolean>
Returns Promise<TElement>
The single element of the input sequence that satisfies a condition.

Throws
No element satisfies the condition in predicate. OR More than one element satisfies the condition in predicate. OR The source sequence is empty.
Inherited from IEnumerable.singleAsync
- Defined in src/types/IEnumerable.ts:617

singleOrDefault

singleOrDefault(predicate?): null | TElement
If predicate is specified returns the only element of a sequence that satisfies a specified condition, ootherwise returns the only element of a sequence. Returns a default value if no such element exists.
Parameters
- Optional predicate: ((x) => boolean)
  A function to test an element for a condition. Optional.
  - - (x): boolean
    - Parameters
      x: TElement
      Returns boolean
Returns null | TElement
The single element of the input sequence that satisfies the condition, or null if no such element is found.

Throws
If predicate is specified more than one element satisfies the condition in predicate, otherwise the input sequence contains more than one element.
Inherited from IEnumerable.singleOrDefault
- Defined in src/types/IEnumerable.ts:628

singleOrDefaultAsync

singleOrDefaultAsync(predicate): Promise<null | TElement>
Returns the only element of a sequence that satisfies a specified condition. Returns a default value if no such element exists.
Parameters
- predicate: ((x) => Promise<boolean>)
  A function to test an element for a condition. Optional.
  - - (x): Promise<boolean>
    - Parameters
      x: TElement
      Returns Promise<boolean>
Returns Promise<null | TElement>
The single element of the input sequence that satisfies the condition, or null if no such element is found.

Throws
If predicate is specified more than one element satisfies the condition in predicate, otherwise the input sequence contains more than one element.
Inherited from IEnumerable.singleOrDefaultAsync
- Defined in src/types/IEnumerable.ts:639

skip

skip(count): IEnumerable<TElement>
Bypasses a specified number of elements in a sequence and then returns the remaining elements.
Parameters
- count: number
  The number of elements to skip before returning the remaining elements.
Returns IEnumerable<TElement>
An IEnumerable that contains the elements that occur after the specified index in the input sequence.
Inherited from IEnumerable.skip
- Defined in src/types/IEnumerable.ts:645

skipWhile

skipWhile(predicate): IEnumerable<TElement>
Bypasses elements in a sequence as long as a specified condition is true and then returns the remaining elements. The element's index is used in the logic of the predicate function.
Parameters
- predicate: ((x, index) => boolean)
  A function to test each source element for a condition; the second parameter of the function represents the index of the source element.
  - - (x, index): boolean
    - Parameters
      x: TElement
      index: number
      Returns boolean
Returns IEnumerable<TElement>
An IEnumerable that contains the elements from the input sequence starting at the first element in the linear series that does not pass the test specified by predicate.
Inherited from IEnumerable.skipWhile
- Defined in src/types/IEnumerable.ts:654

skipWhileAsync

skipWhileAsync(predicate): IAsyncEnumerable<TElement>
Bypasses elements in a sequence as long as a specified condition is true and then returns the remaining elements. The element's index is used in the logic of the predicate function.
Parameters
- predicate: ((x, index) => Promise<boolean>)
  A function to test each source element for a condition; the second parameter of the function represents the index of the source element.
  - - (x, index): Promise<boolean>
    - Parameters
      x: TElement
      index: number
      Returns Promise<boolean>
Returns IAsyncEnumerable<TElement>
An IAsyncEnumerable that contains the elements from the input sequence starting at the first element in the linear series that does not pass the test specified by predicate.
Inherited from IEnumerable.skipWhileAsync
- Defined in src/types/IEnumerable.ts:663

sum

sum(this): number
Computes the sum of the sequence of numeric values.
Parameters
- this: IEnumerable<number>
Returns number
The sum of the values in the sequence.
Inherited from IEnumerable.sum
- Defined in src/types/IEnumerable.ts:668
sum(selector): 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) => number)
  A transform function to apply to each element.
  - - (x): number
    - Parameters
      x: TElement
      Returns number
Returns number
The sum of the projected values.
Inherited from IEnumerable.sum
- Defined in src/types/IEnumerable.ts:675

sumAsync

sumAsync(selector): 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) => Promise<number>)
  An async transform function to apply to each element.
  - - (x): Promise<number>
    - Parameters
      x: TElement
      Returns Promise<number>
Returns Promise<number>
The sum of the projected values.
Inherited from IEnumerable.sumAsync
- Defined in src/types/IEnumerable.ts:682

take

take(amount): IEnumerable<TElement>
Returns a specified number of contiguous elements from the start of a sequence.
Parameters
- amount: number
  The number of elements to return.
Returns IEnumerable<TElement>
An IEnumerable that contains the specified number of elements from the start of the input sequence.
Inherited from IEnumerable.take
- Defined in src/types/IEnumerable.ts:688

takeWhile

takeWhile(predicate): IEnumerable<TElement>
Returns elements from a sequence as long as a specified condition is true. The element's index is used in the logic of the predicate function.
Parameters
- predicate: ((x, index) => boolean)
  A function to test each source element for a condition; the second parameter of the function represents the index of the source element.
  - - (x, index): boolean
    - Parameters
      x: TElement
      index: number
      Returns boolean
Returns IEnumerable<TElement>
An IEnumerable that contains elements from the input sequence that occur before the element at which the test no longer passes.
Inherited from IEnumerable.takeWhile
- Defined in src/types/IEnumerable.ts:697

takeWhileAsync

takeWhileAsync(predicate): IAsyncEnumerable<TElement>
Returns elements from a sequence as long as a specified condition is true. The element's index is used in the logic of the predicate function.
Parameters
- predicate: ((x, index) => 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.
  - - (x, index): Promise<boolean>
    - Parameters
      x: TElement
      index: number
      Returns Promise<boolean>
Returns IAsyncEnumerable<TElement>
An IAsyncEnumerable that contains elements from the input sequence that occur before the element at which the test no longer passes.
Inherited from IEnumerable.takeWhileAsync
- Defined in src/types/IEnumerable.ts:706

toArray

toArray(): TElement[]
Creates an array from a IEnumerable.

Returns TElement[]
An array of elements
Inherited from IEnumerable.toArray
- Defined in src/types/IEnumerable.ts:711

toMap

toMap<TKey>(selector): Map<TKey, TElement[]>
Converts an Iterable to a Map<K, V[]>.
Type Parameters
- TKey
Parameters
- selector: ((x) => TKey)
  A function to serve as a key selector.
  - - (x): TKey
    - Parameters
      x: TElement
      Returns TKey
Returns Map<TKey, TElement[]>
Map<K, V[]>
Inherited from IEnumerable.toMap
- Defined in src/types/IEnumerable.ts:717

toMapAsync

toMapAsync<TKey>(selector): Promise<Map<TKey, TElement[]>>
Converts an Iterable to a Map<K, V[]>.
Type Parameters
- TKey
Parameters
- selector: ((x) => Promise<TKey>)
  An async function to serve as a key selector.
  - - (x): Promise<TKey>
    - Parameters
      x: TElement
      Returns Promise<TKey>
Returns Promise<Map<TKey, TElement[]>>
A promise for Map<K, V[]>
Inherited from IEnumerable.toMapAsync
- Defined in src/types/IEnumerable.ts:723

toObject

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

toObjectAsync

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

toSet

toSet(): Set<TElement>
Converts the iteration to a Set

Returns Set<TElement>
Set containing the iteration values
Inherited from IEnumerable.toSet
- Defined in src/types/IEnumerable.ts:740

union

union(second, comparer?): IEnumerable<TElement>
Produces the set union of two sequences by using scrict equality comparison or a specified IEqualityComparer.
Parameters
- second: Iterable<TElement>
  An Iterable whose distinct elements form the second set for the union.
- Optional comparer: IEqualityComparer<TElement>
  The IEqualityComparer to compare values. Optional.
Returns IEnumerable<TElement>
An IEnumerable that contains the elements from both input sequences, excluding duplicates.
Inherited from IEnumerable.union
- Defined in src/types/IEnumerable.ts:747

unionAsync

unionAsync(second, comparer): IAsyncEnumerable<TElement>
Produces the set union of two sequences by using a specified IAsyncEqualityComparer.
Parameters
- second: Iterable<TElement>
  An Iterable whose distinct elements form the second set for the union.
- comparer: IAsyncEqualityComparer<TElement>
  The IAsyncEqualityComparer to compare values.
Returns IAsyncEnumerable<TElement>
An IAsyncEnumerable that contains the elements from both input sequences, excluding duplicates.
Inherited from IEnumerable.unionAsync
- Defined in src/types/IEnumerable.ts:754

where

where(predicate): IEnumerable<TElement>
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, index) => boolean)
  A function to test each source element for a condition; the second parameter of the function represents the index of the source element.
  - - (x, index): boolean
    - Parameters
      x: TElement
      index: number
      Returns boolean
Returns IEnumerable<TElement>
An IEnumerable that contains elements from the input sequence that satisfy the condition.
Inherited from IEnumerable.where
- Defined in src/types/IEnumerable.ts:762

whereAsync

whereAsync(predicate): IAsyncEnumerable<TElement>
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, index) => 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.
  - - (x, index): Promise<boolean>
    - Parameters
      x: TElement
      index: number
      Returns Promise<boolean>
Returns IAsyncEnumerable<TElement>
An IAsyncEnumerable that contains elements from the input sequence that satisfy the condition.
Inherited from IEnumerable.whereAsync
- Defined in src/types/IEnumerable.ts:770

zip

zip<TSecond>(second): IEnumerable<[TElement, TSecond]>
Creates a tuple of corresponding elements of two sequences, producing a sequence of the results.
Type Parameters
- TSecond
Parameters
- second: Iterable<TSecond>
  The second sequence to merge.
Returns IEnumerable<[TElement, TSecond]>
An IEnumerable<[T, Y]> that contains merged elements of two input sequences.
Inherited from IEnumerable.zip
- Defined in src/types/IEnumerable.ts:776
zip<TSecond, TResult>(second, resultSelector): IEnumerable<TResult>
Applies a specified function to the corresponding elements of two sequences, producing a sequence of the results.
Type Parameters
- TSecond
- TResult
Parameters
- second: Iterable<TSecond>
  The second sequence to merge.
- resultSelector: ((x, y) => TResult)
  A function that specifies how to merge the elements from the two sequences.
  - - (x, y): TResult
    - Parameters
      x: TElement
      y: TSecond
      Returns TResult
Returns IEnumerable<TResult>
An IEnumerable that contains merged elements of two input sequences.
Inherited from IEnumerable.zip
- Defined in src/types/IEnumerable.ts:783

zipAsync

zipAsync<TSecond, TResult>(second, resultSelector): IAsyncEnumerable<TResult>
Applies a specified async function to the corresponding elements of two sequences, producing a sequence of the results.
Type Parameters
- TSecond
- TResult
Parameters
- second: Iterable<TSecond>
  The second sequence to merge.
- resultSelector: ((x, y) => Promise<TResult>)
  An async function that specifies how to merge the elements from the two sequences.
  - - (x, y): Promise<TResult>
    - Parameters
      x: TElement
      y: TSecond
      Returns Promise<TResult>
Returns IAsyncEnumerable<TResult>
An IAsyncEnumerable that contains merged elements of two input sequences.
Inherited from IEnumerable.zipAsync
- Defined in src/types/IEnumerable.ts:793

Interface IGrouping<TKey, TElement>

Type Parameters

TKey

TElement

Hierarchy

Index

Properties

Methods

Properties

Readonly key

Methods

[iterator]

Returns IterableIterator<TElement>

aggregate

Parameters

func: ((x, y) => TElement)

Parameters

x: TElement

y: TElement

Returns TElement

Returns TElement

Type Parameters

TAccumulate

Parameters

seed: TAccumulate

func: ((x, y) => TAccumulate)

Parameters

x: TAccumulate

y: TElement

Returns TAccumulate

Returns TAccumulate

Type Parameters

TAccumulate

TResult

Parameters

seed: TAccumulate

func: ((x, y) => TAccumulate)

Parameters

x: TAccumulate

y: TElement

Returns TAccumulate

resultSelector: ((x) => TResult)

Parameters

x: TAccumulate

Returns TResult

Returns TResult

all

Parameters

predicate: ((x) => boolean)

Parameters

x: TElement

Returns boolean

Returns boolean

allAsync

Parameters

predicate: ((x) => Promise<boolean>)

Parameters

x: TElement

Returns Promise<boolean>

Returns Promise<boolean>

any

Parameters

Optional predicate: ((x) => boolean)

Parameters

x: TElement

Returns boolean

Returns boolean

anyAsync

Parameters

predicate: ((x) => Promise<boolean>)

Parameters

x: TElement

Returns Promise<boolean>

Returns Promise<boolean>

append

Parameters

element: TElement

Returns IEnumerable<TElement>

asAsync

Returns IAsyncEnumerable<TElement>

`Readonly` key

`Optional` predicate: ((x) => boolean)

`Optional` comparer: IEqualityComparer<TElement>

`Optional` predicate: ((x) => boolean)

`Optional` comparer: IEqualityComparer<TElement>