Options
All
  • Public
  • Public/Protected
  • All
Menu

Type parameters

  • T

Hierarchy

Implemented by

Index

Properties

Optional isEndless

isEndless: boolean

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

Methods

aggregate

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

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

          • a: T
          • b: T

          Returns T

    • Optional seed: T

    Returns T

all

  • Parameters

    Returns boolean

alternate

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

alternateMultiple

alternateSingle

  • alternateSingle(value: T)

any

asEnumerable

  • asEnumerable()

average

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

    • Optional selector: Selector<T, 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: T, compareSelector?: Selector<T, TCompare>): boolean
  • Type parameters

    • TCompare

    Parameters

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

    Returns boolean

copyTo

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

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

    Returns T[]

count

  • Parameters

    Returns number

defaultIfEmpty

  • defaultIfEmpty(defaultValue?: T)

dispose

  • dispose(): void
  • Returns void

distinct

  • distinct(compareSelector?: function)
  • Parameters

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

          • value: T

          Returns T

distinctUntilChanged

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

doAction

elementAt

  • elementAt(index: number): T

elementAtOrDefault

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

every

  • Parameters

    Returns boolean

except

finallyAction

  • finallyAction(action: function)

first

  • first(): T

firstOrDefault

  • firstOrDefault(defaultValue?: T): T

flatten

forEach

  • Parameters

    Returns void

force

  • force(): void

getEnumerator

groupBy

  • Type parameters

    • TKey

    Parameters

    Returns ILinqEnumerable<IGrouping<TKey, T>>

  • Type parameters

    • TKey

    • TCompare

    Parameters

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

    Returns ILinqEnumerable<IGrouping<TKey, T>>

groupJoin

  • Type parameters

    • TInner

    • TKey

    • TResult

    • TCompare

    Parameters

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

          • outer: T
          • inner: TInner[]

          Returns TResult

    • Optional compareSelector: Selector<TKey, TCompare>

    Returns ILinqEnumerable<TResult>

indexOf

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

    • TCompare

    Parameters

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

    Returns number

insertAt

intersect

  • Type parameters

    • TCompare

    Parameters

isEmpty

  • isEmpty(): boolean

join

  • Type parameters

    • TInner

    • TKey

    • TResult

    • TCompare

    Parameters

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

          • outer: T
          • inner: TInner

          Returns TResult

    • Optional compareSelector: Selector<TKey, TCompare>

    Returns ILinqEnumerable<TResult>

last

  • last(): T
  • Returns T

lastIndexOf

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

    • TCompare

    Parameters

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

    Returns number

lastOrDefault

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

    • Optional defaultValue: T

    Returns T

max

  • max(): T
  • Returns T

maxBy

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

    • TCompare

    Parameters

    • Optional keySelector: Selector<T, TCompare>

    Returns T

memoize

  • memoize()

merge

min

  • min(): T
  • Returns T

minBy

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

    • TCompare

    Parameters

    • Optional keySelector: Selector<T, TCompare>

    Returns T

ofType

orderBy

orderByDescending

orderUsing

orderUsingReversed

pairwise

  • Type parameters

    • TSelect

    Parameters

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

          • prev: T
          • current: T

          Returns TSelect

    Returns ILinqEnumerable<TSelect>

partitionBy

  • Type parameters

    • TKey

    Parameters

    Returns ILinqEnumerable<IGrouping<TKey, T>>

  • Type parameters

    • TKey

    • TElement

    • TCompare

    Parameters

    • keySelector: Selector<T, TKey>
    • elementSelector: Selector<T, TElement>
    • Optional resultSelector: function
        • (key: TKey, element: TElement[]): IGrouping<TKey, TElement>
        • Parameters

          • key: TKey
          • element: TElement[]

          Returns IGrouping<TKey, TElement>

    • Optional compareSelector: Selector<TKey, TCompare>

    Returns ILinqEnumerable<IGrouping<TKey, TElement>>

product

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

    • Optional selector: Selector<T, number>

    Returns number

quotient

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

    • Optional selector: Selector<T, number>

    Returns number

reverse

  • reverse()

scan

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

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

          • a: T
          • b: T

          Returns T

    • Optional seed: T

select

selectMany

sequenceEqual

share

  • share()

shuffle

  • shuffle()

single

  • single(): T

singleOrDefault

  • singleOrDefault(defaultValue?: T): T

skip

  • skip(count: number)
  • Parameters

    • count: number

skipToLast

  • skipToLast(count: number)
  • Parameters

    • count: number

skipWhile

  • Parameters

some

  • Parameters

    Returns boolean

sum

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

    • Optional selector: Selector<T, number>

    Returns number

take

takeExceptLast

  • takeExceptLast(count?: number)
  • Parameters

    • Optional count: number

takeUntil

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

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

takeWhile

  • Parameters

toArray

  • Parameters

    Returns T[]

toDictionary

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

    • TKey

    • TValue

    • TCompare

    Parameters

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

    Returns IDictionary<TKey, TValue>

toJoinedString

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

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

    Returns string

toLookup

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

    • TKey

    • TValue

    • TCompare

    Parameters

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

    Returns ILookup<TKey, TValue>

toMap

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

    • TResult

    Parameters

    Returns IMap<TResult>

traverseBreadthFirst

  • traverseBreadthFirst(childrenSelector: function): ILinqEnumerable<T>
  • 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<T>
  • 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: T, second: TSecond, index?: number): TResult
        • Parameters

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

          Returns TResult

    Returns ILinqEnumerable<TResult>

zipMultiple

  • Type parameters

    • TSecond

    • TResult

    Parameters

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

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

          Returns TResult

    Returns ILinqEnumerable<TResult>

Generated using TypeDoc