Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface IGrouping<TKey, TElement>

Type parameters

  • TKey

  • TElement

Hierarchy

Index

Properties

Optional isEndless

isEndless: boolean

Provides a way of flagging endless enumerations that may cause issues.

key

key: TKey

Methods

aggregate

  • aggregate(func: function, seed?: TElement): TElement
  • Parameters

    • func: function
        • (a: TElement, b: TElement): TElement
        • Parameters

          • a: TElement
          • b: TElement

          Returns TElement

    • Optional seed: TElement

    Returns TElement

all

  • all(predicate: Predicate<TElement>): boolean
  • Parameters

    Returns boolean

alternate

  • alternate(...sequence: TElement[])

alternateMultiple

alternateSingle

  • alternateSingle(value: TElement)

any

  • any(predicate?: Predicate<TElement>): boolean

asEnumerable

  • asEnumerable()

average

  • average(selector?: Selector<TElement, number>): number
  • Parameters

    • Optional selector: Selector<TElement, number>

    Returns number

buffer

catchError

  • catchError(handler: function)
  • Parameters

    • handler: function
        • (e: any): void
        • Parameters

          • e: any

          Returns void

choose

concat

contains

  • contains<TCompare>(value: TElement, compareSelector?: Selector<TElement, TCompare>): boolean
  • Type parameters

    • TCompare

    Parameters

    • value: TElement
    • Optional compareSelector: Selector<TElement, TCompare>

    Returns boolean

copyTo

  • copyTo(target: TElement[], index?: number, count?: number): TElement[]
  • Parameters

    • target: TElement[]
    • Optional index: number
    • Optional count: number

    Returns TElement[]

count

  • count(predicate?: Predicate<TElement>): number
  • Parameters

    Returns number

defaultIfEmpty

  • defaultIfEmpty(defaultValue?: TElement)

dispose

  • dispose(): void
  • Returns void

distinct

  • distinct(compareSelector?: function)
  • Parameters

    • Optional compareSelector: function
        • (value: TElement): TElement
        • Parameters

          • value: TElement

          Returns TElement

distinctUntilChanged

  • distinctUntilChanged<TCompare>(compareSelector?: Selector<TElement, TCompare>)

doAction

elementAt

  • elementAt(index: number): TElement

elementAtOrDefault

  • elementAtOrDefault(index: number, defaultValue?: TElement): TElement

every

  • every(predicate: Predicate<TElement>): boolean
  • Parameters

    Returns boolean

except

finallyAction

  • finallyAction(action: function)

first

  • first(): TElement

firstOrDefault

  • firstOrDefault(defaultValue?: TElement): TElement

flatten

forEach

force

  • force(): void

getEnumerator

groupBy

groupJoin

  • Type parameters

    • TInner

    • TKey

    • TResult

    • TCompare

    Parameters

    • inner: IEnumerableOrArray
    • outerKeySelector: Selector<TElement, TKey>
    • innerKeySelector: Selector<TInner, TKey>
    • resultSelector: function
        • (outer: TElement, inner: TInner[]): TResult
        • Parameters

          • outer: TElement
          • inner: TInner[]

          Returns TResult

    • Optional compareSelector: Selector<TKey, TCompare>

    Returns ILinqEnumerable<TResult>

indexOf

  • indexOf<TCompare>(value: TElement, compareSelector?: Selector<TElement, TCompare>): number
  • Type parameters

    • TCompare

    Parameters

    • value: TElement
    • Optional compareSelector: Selector<TElement, TCompare>

    Returns number

insertAt

intersect

isEmpty

  • isEmpty(): boolean

join

  • Type parameters

    • TInner

    • TKey

    • TResult

    • TCompare

    Parameters

    • inner: IEnumerableOrArray
    • outerKeySelector: Selector<TElement, TKey>
    • innerKeySelector: Selector<TInner, TKey>
    • resultSelector: function
        • (outer: TElement, inner: TInner): TResult
        • Parameters

          • outer: TElement
          • inner: TInner

          Returns TResult

    • Optional compareSelector: Selector<TKey, TCompare>

    Returns ILinqEnumerable<TResult>

last

  • last(): TElement
  • Returns TElement

lastIndexOf

  • lastIndexOf<TCompare>(value: TElement, compareSelector?: Selector<TElement, TCompare>): number
  • Type parameters

    • TCompare

    Parameters

    • value: TElement
    • Optional compareSelector: Selector<TElement, TCompare>

    Returns number

lastOrDefault

  • lastOrDefault(defaultValue?: TElement): TElement
  • Parameters

    • Optional defaultValue: TElement

    Returns TElement

max

  • max(): TElement
  • Returns TElement

maxBy

  • maxBy<TCompare>(keySelector?: Selector<TElement, TCompare>): TElement
  • Type parameters

    • TCompare

    Parameters

    • Optional keySelector: Selector<TElement, TCompare>

    Returns TElement

memoize

  • memoize()

merge

min

  • min(): TElement
  • Returns TElement

minBy

  • minBy<TCompare>(keySelector?: Selector<TElement, TCompare>): TElement
  • Type parameters

    • TCompare

    Parameters

    • Optional keySelector: Selector<TElement, TCompare>

    Returns TElement

ofType

orderBy

orderByDescending

orderUsing

orderUsingReversed

pairwise

  • Type parameters

    • TSelect

    Parameters

    • selector: function
        • (prev: TElement, current: TElement): TSelect
        • Parameters

          • prev: TElement
          • current: TElement

          Returns TSelect

    Returns ILinqEnumerable<TSelect>

partitionBy

product

  • product(selector?: Selector<TElement, number>): number
  • Parameters

    • Optional selector: Selector<TElement, number>

    Returns number

quotient

  • quotient(selector?: Selector<TElement, number>): number
  • Parameters

    • Optional selector: Selector<TElement, number>

    Returns number

reverse

  • reverse()

scan

  • scan(func: function, seed?: TElement)
  • Parameters

    • func: function
        • (a: TElement, b: TElement): TElement
        • Parameters

          • a: TElement
          • b: TElement

          Returns TElement

    • Optional seed: TElement

select

selectMany

sequenceEqual

share

  • share()

shuffle

  • shuffle()

single

  • single(): TElement

singleOrDefault

  • singleOrDefault(defaultValue?: TElement): TElement

skip

  • skip(count: number)
  • Parameters

    • count: number

skipToLast

  • skipToLast(count: number)

skipWhile

some

  • some(predicate: Predicate<TElement>): boolean
  • Parameters

    Returns boolean

sum

  • sum(selector?: Selector<TElement, number>): number
  • Parameters

    • Optional selector: Selector<TElement, number>

    Returns number

take

takeExceptLast

  • takeExceptLast(count?: number)

takeUntil

  • takeUntil(predicate: Predicate<TElement>, includeUntilValue?: boolean)
  • Parameters

    • predicate: Predicate<TElement>
    • Optional includeUntilValue: boolean

takeWhile

toArray

  • toArray(predicate?: Predicate<TElement>): TElement[]
  • Parameters

    Returns TElement[]

toDictionary

  • toDictionary<TKey, TValue, TCompare>(keySelector: Selector<TElement, TKey>, elementSelector: Selector<TElement, TValue>, compareSelector?: Selector<TKey, TCompare>): IDictionary<TKey, TValue>
  • Type parameters

    • TKey

    • TValue

    • TCompare

    Parameters

    • keySelector: Selector<TElement, TKey>
    • elementSelector: Selector<TElement, TValue>
    • Optional compareSelector: Selector<TKey, TCompare>

    Returns IDictionary<TKey, TValue>

toJoinedString

  • toJoinedString(separator?: string, selector?: Selector<TElement, string>): string
  • Parameters

    • Optional separator: string
    • Optional selector: Selector<TElement, string>

    Returns string

toLookup

  • toLookup<TKey, TValue, TCompare>(keySelector: Selector<TElement, TKey>, elementSelector?: Selector<TElement, TValue>, compareSelector?: Selector<TKey, TCompare>): ILookup<TKey, TValue>
  • Type parameters

    • TKey

    • TValue

    • TCompare

    Parameters

    • keySelector: Selector<TElement, TKey>
    • Optional elementSelector: Selector<TElement, TValue>
    • Optional compareSelector: Selector<TKey, TCompare>

    Returns ILookup<TKey, TValue>

toMap

  • toMap<TResult>(keySelector: Selector<TElement, string>, elementSelector: Selector<TElement, TResult>): IMap<TResult>
  • Type parameters

    • TResult

    Parameters

    • keySelector: Selector<TElement, string>
    • elementSelector: Selector<TElement, TResult>

    Returns IMap<TResult>

traverseBreadthFirst

  • traverseBreadthFirst(childrenSelector: function): ILinqEnumerable<TElement>
  • traverseBreadthFirst<TNode>(childrenSelector: function): ILinqEnumerable<TNode>
  • traverseBreadthFirst<TResult>(childrenSelector: function, resultSelector?: function): ILinqEnumerable<TResult>
  • traverseBreadthFirst<TNode, TResult>(childrenSelector: function, resultSelector?: function): ILinqEnumerable<TResult>

traverseDepthFirst

  • traverseDepthFirst(childrenSelector: function): ILinqEnumerable<TElement>
  • traverseDepthFirst<TNode>(childrenSelector: function): ILinqEnumerable<TNode>
  • traverseDepthFirst<TResult>(childrenSelector: function, resultSelector?: function): ILinqEnumerable<TResult>
  • traverseDepthFirst<TNode, TResult>(childrenSelector: function, resultSelector?: function): ILinqEnumerable<TResult>

union

where

zip

  • Type parameters

    • TSecond

    • TResult

    Parameters

    • second: IEnumerableOrArray
    • resultSelector: function
        • (first: TElement, second: TSecond, index?: number): TResult
        • Parameters

          • first: TElement
          • second: TSecond
          • Optional index: number

          Returns TResult

    Returns ILinqEnumerable<TResult>

zipMultiple

  • Type parameters

    • TSecond

    • TResult

    Parameters

    • second: IArray
    • resultSelector: function
        • (first: TElement, second: TSecond, index?: number): TResult
        • Parameters

          • first: TElement
          • second: TSecond
          • Optional index: number

          Returns TResult

    Returns ILinqEnumerable<TResult>

Generated using TypeDoc