Options
All
  • Public
  • Public/Protected
  • All
Menu

Module "iterable-query/fn"

Index

Interfaces

Functions (Query)

Functions (Scalar)

Functions (Subquery)

Functions (Order)

Functions (Join)

Functions (Hierarchy)

Functions (Query)

choose

  • Creates an Iterable that iterates the elements from sources picked from a list based on the result of a lazily evaluated choice.

    category

    Query

    Type parameters

    • K
    • V

    Parameters

    • chooser: function

      A callback used to choose a source.

        • (): K
        • Returns K

    • choices: Queryable<Choice<K, V>>

      A Queryable of key/value pairs, where each value is a Queryable object.

    • Optional otherwise: Queryable<V>

      A default source to use when another choice could not be made.

    Returns Iterable<V>

chooseAsync

  • Creates an Iterable that iterates the elements from sources picked from a list based on the result of a lazily evaluated choice.

    category

    Query

    Type parameters

    • K
    • V

    Parameters

    • chooser: function

      A callback used to choose a source.

        • (): PromiseLike<K> | K
        • Returns PromiseLike<K> | K

    • choices: AsyncQueryable<AsyncChoice<K, V>>

      An AsyncQueryable of key/value pairs, where each value is an AsyncQueryable object.

    • Optional otherwise: AsyncQueryable<V>

      A default source to use when another choice could not be made.

    Returns AsyncIterable<V>

conditional

  • Creates an Iterable that iterates the elements from one of two sources based on the result of a lazily evaluated condition.

    category

    Query

    Type parameters

    • T

    Parameters

    • condition: function

      A callback used to choose a source.

        • (): boolean
        • Returns boolean

    • thenQueryable: Queryable<T>

      The source to use when the callback evaluates to true.

    • Optional elseQueryable: Queryable<T>

      The source to use when the callback evaluates to false.

    Returns Iterable<T>

conditionalAsync

  • Creates an AsyncIterable that iterates the elements from one of two sources based on the result of a lazily evaluated condition.

    category

    Query

    Type parameters

    • T

    Parameters

    • condition: function

      A callback used to choose a source.

        • (): PromiseLike<boolean> | boolean
        • Returns PromiseLike<boolean> | boolean

    • thenQueryable: AsyncQueryable<T>

      The source to use when the callback evaluates to true.

    • Optional elseQueryable: AsyncQueryable<T>

      The source to use when the callback evaluates to false.

    Returns AsyncIterable<T>

consume

consumeAsync

continuous

continuousAsync

  • continuousAsync<T>(value: PromiseLike<T> | T): AsyncIterable<T>

empty

emptyAsync

generate

  • generate<T>(count: number, generator: function): Iterable<T>
  • Creates an Iterable whose values are provided by a callback executed a provided number of times.

    category

    Query

    Type parameters

    • T

    Parameters

    • count: number

      The number of times to execute the callback.

    • generator: function

      The callback to execute.

        • (offset: number): T
        • Parameters

          • offset: number

          Returns T

    Returns Iterable<T>

generateAsync

  • generateAsync<T>(count: number, generator: function): AsyncIterable<T>
  • Creates an AsyncIterable whose values are provided by a callback executed a provided number of times.

    category

    Query

    Type parameters

    • T

    Parameters

    • count: number

      The number of times to execute the callback.

    • generator: function

      The callback to execute.

        • (offset: number): PromiseLike<T> | T
        • Parameters

          • offset: number

          Returns PromiseLike<T> | T

    Returns AsyncIterable<T>

if

  • Creates an Iterable that iterates the elements from one of two sources based on the result of a lazily evaluated condition.

    category

    Query

    Type parameters

    • T

    Parameters

    • condition: function

      A callback used to choose a source.

        • (): boolean
        • Returns boolean

    • thenQueryable: Queryable<T>

      The source to use when the callback evaluates to true.

    • Optional elseQueryable: Queryable<T>

      The source to use when the callback evaluates to false.

    Returns Iterable<T>

ifAsync

  • Creates an AsyncIterable that iterates the elements from one of two sources based on the result of a lazily evaluated condition.

    category

    Query

    Type parameters

    • T

    Parameters

    • condition: function

      A callback used to choose a source.

        • (): PromiseLike<boolean> | boolean
        • Returns PromiseLike<boolean> | boolean

    • thenQueryable: AsyncQueryable<T>

      The source to use when the callback evaluates to true.

    • Optional elseQueryable: AsyncQueryable<T>

      The source to use when the callback evaluates to false.

    Returns AsyncIterable<T>

objectEntries

objectEntriesAsync

objectKeys

  • objectKeys<T>(source: T): Iterable<Extract<keyof T, string>>
  • Creates an Iterable for the own property keys of an object.

    category

    Query

    Type parameters

    • T: object

    Parameters

    • source: T

      An object.

    Returns Iterable<Extract<keyof T, string>>

objectKeysAsync

  • objectKeysAsync<T>(source: PromiseLike<T> | T): AsyncIterable<Extract<keyof T, string>>

objectValues

  • objectValues<T>(source: T): Iterable<T[Extract<keyof T, string>]>
  • Creates an Iterable for the own property values of an object.

    category

    Query

    Type parameters

    • T: object

    Parameters

    • source: T

      An object.

    Returns Iterable<T[Extract<keyof T, string>]>

objectValuesAsync

  • objectValuesAsync<T>(source: PromiseLike<T> | T): AsyncIterable<T[Extract<keyof T, string>]>

once

onceAsync

range

  • range(start: number, end: number, increment?: number): Iterable<number>
  • Creates an Iterable over a range of numbers.

    category

    Query

    Parameters

    • start: number

      The starting number of the range.

    • end: number

      The ending number of the range.

    • Default value increment: number = 1

      The amount by which to change between each itereated value.

    Returns Iterable<number>

repeat

  • repeat<T>(value: T, count: number): Iterable<T>
  • Creates an Iterable for a value repeated a provided number of times.

    category

    Query

    Type parameters

    • T

    Parameters

    • value: T

      The value for each element of the Iterable.

    • count: number

      The number of times to repeat the value.

    Returns Iterable<T>

repeatAsync

  • repeatAsync<T>(value: PromiseLike<T> | T, count: number): AsyncIterable<T>
  • Creates an Iterable for a value repeated a provided number of times.

    category

    Query

    Type parameters

    • T

    Parameters

    • value: PromiseLike<T> | T

      The value for each element of the Iterable.

    • count: number

      The number of times to repeat the value.

    Returns AsyncIterable<T>

Functions (Scalar)

average

  • average(source: Queryable<number>): number
  • average<T>(source: Queryable<T>, elementSelector: function): number
  • Computes the average for a series of numbers.

    category

    Scalar

    Parameters

    Returns number

  • Computes the average for a series of numbers.

    category

    Scalar

    Type parameters

    • T

    Parameters

    • source: Queryable<T>

      A Queryable object.

    • elementSelector: function

      A callback used to convert a value in source to a number.

        • (element: T): number
        • Parameters

          • element: T

          Returns number

    Returns number

averageAsync

  • Computes the average for a series of numbers. NOTE: If any element is not a number, this overload will throw.

    category

    Scalar

    Parameters

    Returns Promise<number>

  • Computes the average for a series of numbers.

    category

    Scalar

    Type parameters

    • T

    Parameters

    • source: AsyncQueryable<T>

      An AsyncQueryable object.

    • elementSelector: function

      A callback used to convert a value in source to a number.

        • (element: T): number | PromiseLike<number>
        • Parameters

          • element: T

          Returns number | PromiseLike<number>

    Returns Promise<number>

break

  • Creates a tuple whose first element is a HierarchyIterable containing the first span of elements that do not match the supplied predicate, and whose second element is a HierarchyIterable containing the remaining elements.

    The first HierarchyIterable is eagerly evaluated, while the second HierarchyIterable is lazily evaluated.

    category

    Scalar

    Type parameters

    • TNode
    • T: TNode

    Parameters

    • source: HierarchyIterable<TNode, T>

      A HierarchyIterable object.

    • predicate: function

      The predicate used to match elements.

        • (element: T): boolean
        • Parameters

          • element: T

          Returns boolean

    Returns [HierarchyIterable<TNode, T>, HierarchyIterable<TNode, T>]

  • Creates a tuple whose first element is an Iterable containing the first span of elements that do not match the supplied predicate, and whose second element is an Iterable containing the remaining elements.

    The first Iterable is eagerly evaluated, while the second Iterable is lazily evaluated.

    category

    Scalar

    Type parameters

    • T

    Parameters

    • source: Queryable<T>

      A HierarchyIterable object.

    • predicate: function

      The predicate used to match elements.

        • (element: T): boolean
        • Parameters

          • element: T

          Returns boolean

    Returns [Iterable<T>, Iterable<T>]

breakAsync

corresponds

  • Computes a scalar value indicating whether every element in left corresponds to a matching element in right at the same position.

    category

    Scalar

    Type parameters

    • T

    Parameters

    Returns boolean

  • Computes a scalar value indicating whether every element in left corresponds to a matching element in right at the same position.

    category

    Scalar

    Type parameters

    • T
    • U

    Parameters

    • left: Queryable<T>

      A Queryable object.

    • right: Queryable<U>

      A Queryable object.

    • equalityComparison: function

      An optional callback used to compare the equality of two elements.

        • (left: T, right: U): boolean
        • Parameters

          • left: T
          • right: U

          Returns boolean

    Returns boolean

correspondsAsync

count

  • count<T>(source: Queryable<T>, predicate?: function): number
  • Counts the number of elements, optionally filtering elements using the supplied callback.

    category

    Scalar

    Type parameters

    • T

    Parameters

    • source: Queryable<T>

      A Queryable object.

    • Default value predicate: function = True

      An optional callback used to match each element.

        • (element: T): boolean
        • Parameters

          • element: T

          Returns boolean

    Returns number

countAsync

  • Counts the number of elements, optionally filtering elements using the supplied callback.

    category

    Scalar

    Type parameters

    • T

    Parameters

    • source: AsyncQueryable<T>

      A Queryable object.

    • Default value predicate: function = True

      An optional callback used to match each element.

        • (element: T): boolean | PromiseLike<boolean>
        • Parameters

          • element: T

          Returns boolean | PromiseLike<boolean>

    Returns Promise<number>

drain

drainAsync

elementAt

  • elementAt<T>(source: Queryable<T>, offset: number): T | undefined
  • Finds the value at the provided offset. A negative offset starts from the last element.

    category

    Scalar

    Type parameters

    • T

    Parameters

    Returns T | undefined

elementAtAsync

endsWith

  • Computes a scalar value indicating whether the elements of left end with the same sequence of elements in right.

    category

    Scalar

    Type parameters

    • T

    Parameters

    Returns boolean

  • Computes a scalar value indicating whether the elements of left end with the same sequence of elements in right.

    category

    Scalar

    Type parameters

    • T
    • U

    Parameters

    • left: Queryable<T>

      A Queryable object.

    • right: Queryable<U>

      A Queryable object.

    • equalityComparison: function

      An optional callback used to compare the equality of two elements.

        • (left: T, right: U): boolean
        • Parameters

          • left: T
          • right: U

          Returns boolean

    Returns boolean

endsWithAsync

eval

evalAsync

every

  • every<T, U>(source: Queryable<T>, predicate: function): boolean
  • every<T>(source: Queryable<T>, predicate: function): boolean
  • Computes a scalar value indicating whether all elements match the supplied callback.

    category

    Scalar

    Type parameters

    • T
    • U: T

    Parameters

    • source: Queryable<T>

      A Queryable object.

    • predicate: function

      A callback used to match each element.

        • (element: T): boolean
        • Parameters

          • element: T

          Returns boolean

    Returns boolean

  • Computes a scalar value indicating whether all elements match the supplied callback.

    category

    Scalar

    Type parameters

    • T

    Parameters

    • source: Queryable<T>

      A Queryable object.

    • predicate: function

      A callback used to match each element.

        • (element: T): boolean
        • Parameters

          • element: T

          Returns boolean

    Returns boolean

everyAsync

  • Computes a scalar value indicating whether all elements match the supplied callback.

    category

    Scalar

    Type parameters

    • T

    Parameters

    • source: AsyncQueryable<T>

      An AsyncQueryable object.

    • predicate: function

      A callback used to match each element.

        • (element: T): boolean | PromiseLike<boolean>
        • Parameters

          • element: T

          Returns boolean | PromiseLike<boolean>

    Returns Promise<boolean>

first

  • first<T>(source: Queryable<T>, predicate?: function): T | undefined
  • Gets the first element, optionally filtering elements using the supplied callback.

    category

    Scalar

    Type parameters

    • T

    Parameters

    • source: Queryable<T>

      A Queryable object.

    • Default value predicate: function = True

      An optional callback used to match each element.

        • (element: T): boolean
        • Parameters

          • element: T

          Returns boolean

    Returns T | undefined

firstAsync

  • Gets the first element, optionally filtering elements using the supplied callback.

    category

    Scalar

    Type parameters

    • T
    • U: T

    Parameters

    • source: AsyncQueryable<T>

      A Queryable object.

    • predicate: function

      An optional callback used to match each element.

        • (element: T): boolean
        • Parameters

          • element: T

          Returns boolean

    Returns Promise<U | undefined>

  • Gets the first element, optionally filtering elements using the supplied callback.

    category

    Scalar

    Type parameters

    • T

    Parameters

    • source: AsyncQueryable<T>

      A Queryable object.

    • Optional predicate: undefined | function

      An optional callback used to match each element.

    Returns Promise<T | undefined>

forEach

  • forEach<T>(source: Queryable<T>, callback: function): void
  • Invokes a callback for each element of source.

    category

    Scalar

    Type parameters

    • T

    Parameters

    • source: Queryable<T>

      A Queryable object.

    • callback: function

      The callback to invoke.

        • (element: T, offset: number): void
        • Parameters

          • element: T
          • offset: number

          Returns void

    Returns void

forEachAsync

  • Invokes a callback for each element of source.

    category

    Scalar

    Type parameters

    • T

    Parameters

    • source: AsyncQueryable<T>

      An AsyncQueryable object.

    • callback: function

      The callback to invoke.

        • (element: T, offset: number): void | PromiseLike<void>
        • Parameters

          • element: T
          • offset: number

          Returns void | PromiseLike<void>

    Returns Promise<void>

includes

  • includes<T>(source: Queryable<T>, value: T): boolean
  • includes<T, U>(source: Queryable<T>, value: U, equalityComparison: function): boolean
  • Computes a scalar value indicating whether the provided value is included in a Queryable.

    category

    Scalar

    Type parameters

    • T

    Parameters

    Returns boolean

  • Computes a scalar value indicating whether the provided value is included in a Queryable.

    category

    Scalar

    Type parameters

    • T
    • U

    Parameters

    • source: Queryable<T>

      A Queryable object.

    • value: U

      A value.

    • equalityComparison: function

      An optional callback used to compare the equality of two elements.

        • (left: T, right: U): boolean
        • Parameters

          • left: T
          • right: U

          Returns boolean

    Returns boolean

includesAsync

  • Computes a scalar value indicating whether the provided value is included in an AsyncQueryable.

    category

    Scalar

    Type parameters

    • T

    Parameters

    Returns Promise<boolean>

  • Computes a scalar value indicating whether the provided value is included in an AsyncQueryable.

    category

    Scalar

    Type parameters

    • T
    • U

    Parameters

    • source: AsyncQueryable<T>

      An AsyncQueryable object.

    • value: U

      A value.

    • equalityComparison: function

      An optional callback used to compare the equality of two elements.

        • (left: T, right: U): boolean
        • Parameters

          • left: T
          • right: U

          Returns boolean

    Returns Promise<boolean>

includesSequence

  • Computes a scalar value indicating whether the elements of left include an exact sequence of elements from right.

    category

    Scalar

    Type parameters

    • T

    Parameters

    Returns boolean

  • Computes a scalar value indicating whether the elements of left include an exact sequence of elements from right.

    category

    Scalar

    Type parameters

    • T
    • U

    Parameters

    • left: Queryable<T>

      A Queryable object.

    • right: Queryable<U>

      A Queryable object.

    • equalityComparison: function

      A callback used to compare the equality of two elements.

        • (left: T, right: U): boolean
        • Parameters

          • left: T
          • right: U

          Returns boolean

    Returns boolean

includesSequenceAsync

last

  • last<T>(source: Queryable<T>, predicate?: function): T | undefined
  • Gets the last element of a Queryable, optionally filtering elements using the supplied callback.

    category

    Scalar

    Type parameters

    • T

    Parameters

    • source: Queryable<T>

      A Queryable object.

    • Default value predicate: function = True

      An optional callback used to match each element.

        • (element: T): boolean
        • Parameters

          • element: T

          Returns boolean

    Returns T | undefined

lastAsync

  • Gets the last element of a Queryable, optionally filtering elements using the supplied callback.

    category

    Scalar

    Type parameters

    • T
    • U: T

    Parameters

    • source: AsyncQueryable<T>

      An AsyncQueryable object.

    • predicate: function

      An optional callback used to match each element.

        • (element: T): boolean
        • Parameters

          • element: T

          Returns boolean

    Returns Promise<U | undefined>

  • Gets the last element of a Queryable, optionally filtering elements using the supplied callback.

    category

    Scalar

    Type parameters

    • T

    Parameters

    • source: AsyncQueryable<T>

      An AsyncQueryable object.

    • Optional predicate: undefined | function

      An optional callback used to match each element.

    Returns Promise<T | undefined>

max

  • max<T>(source: Queryable<T>, comparison?: function): T | undefined
  • Gets the maximum element of a Queryable, optionally comparing elements using the supplied callback.

    category

    Scalar

    Type parameters

    • T

    Parameters

    • source: Queryable<T>

      A Queryable object.

    • Default value comparison: function = CompareValues

      An optional callback used to compare two elements.

        • (x: T, y: T): number
        • Parameters

          • x: T
          • y: T

          Returns number

    Returns T | undefined

maxAsync

  • Gets the maximum element of an AsyncQueryable, optionally comparing elements using the supplied callback.

    category

    Scalar

    Type parameters

    • T

    Parameters

    • source: AsyncQueryable<T>

      An AsyncQueryable object.

    • Default value comparison: function = CompareValues

      An optional callback used to compare two elements.

        • (x: T, y: T): number
        • Parameters

          • x: T
          • y: T

          Returns number

    Returns Promise<T | undefined>

min

  • min<T>(source: Queryable<T>, comparison?: function): T | undefined
  • Gets the minimum element of a Queryable, optionally comparing elements using the supplied callback.

    category

    Scalar

    Type parameters

    • T

    Parameters

    • source: Queryable<T>

      A Queryable object.

    • Default value comparison: function = CompareValues

      An optional callback used to compare two elements.

        • (x: T, y: T): number
        • Parameters

          • x: T
          • y: T

          Returns number

    Returns T | undefined

minAsync

  • Gets the minimum element of an AsyncQueryable, optionally comparing elements using the supplied callback.

    category

    Scalar

    Type parameters

    • T

    Parameters

    • source: AsyncQueryable<T>

      An AsyncQueryable object.

    • Default value comparison: function = CompareValues

      An optional callback used to compare two elements.

        • (x: T, y: T): number
        • Parameters

          • x: T
          • y: T

          Returns number

    Returns Promise<T | undefined>

nth

  • nth<T>(source: Queryable<T>, offset: number): T | undefined

nthAsync

reduce

  • reduce<T>(source: Queryable<T>, accumulator: function): T
  • reduce<T, U>(source: Queryable<T>, accumulator: function, seed: U, resultSelector?: undefined | function): U
  • reduce<T, U, R>(source: Queryable<T>, accumulator: function, seed: U, resultSelector: function): R
  • Computes a scalar value by applying an accumulator callback over each element.

    category

    Scalar

    Type parameters

    • T

    Parameters

    • source: Queryable<T>

      A Queryable object.

    • accumulator: function

      the callback used to compute the result.

        • (current: T, element: T, offset: number): T
        • Parameters

          • current: T
          • element: T
          • offset: number

          Returns T

    Returns T

  • Computes a scalar value by applying an accumulator callback over each element.

    category

    Scalar

    Type parameters

    • T
    • U

    Parameters

    • source: Queryable<T>

      A Queryable object.

    • accumulator: function

      the callback used to compute the result.

        • (current: U, element: T, offset: number): U
        • Parameters

          • current: U
          • element: T
          • offset: number

          Returns U

    • seed: U

      An optional seed value.

    • Optional resultSelector: undefined | function

      An optional callback used to compute the final result.

    Returns U

  • Computes a scalar value by applying an accumulator callback over each element.

    category

    Scalar

    Type parameters

    • T
    • U
    • R

    Parameters

    • source: Queryable<T>

      A Queryable object.

    • accumulator: function

      the callback used to compute the result.

        • (current: U, element: T, offset: number): U
        • Parameters

          • current: U
          • element: T
          • offset: number

          Returns U

    • seed: U

      An optional seed value.

    • resultSelector: function

      An optional callback used to compute the final result.

        • (result: U, count: number): R
        • Parameters

          • result: U
          • count: number

          Returns R

    Returns R

reduceAsync

  • Computes a scalar value by applying an accumulator callback over each element.

    category

    Scalar

    Type parameters

    • T

    Parameters

    • source: AsyncQueryable<T>

      An AsyncQueryable object.

    • accumulator: function

      the callback used to compute the result.

        • (current: T, element: T, offset: number): T | PromiseLike<T>
        • Parameters

          • current: T
          • element: T
          • offset: number

          Returns T | PromiseLike<T>

    Returns Promise<T>

  • Computes a scalar value by applying an accumulator callback over each element.

    category

    Scalar

    Type parameters

    • T
    • U

    Parameters

    • source: AsyncQueryable<T>

      An AsyncQueryable object.

    • accumulator: function

      the callback used to compute the result.

        • (current: U, element: T, offset: number): U | PromiseLike<U>
        • Parameters

          • current: U
          • element: T
          • offset: number

          Returns U | PromiseLike<U>

    • seed: U

      An optional seed value.

    Returns Promise<U>

  • Computes a scalar value by applying an accumulator callback over each element.

    category

    Scalar

    Type parameters

    • T
    • U
    • R

    Parameters

    • source: AsyncQueryable<T>

      An AsyncQueryable object.

    • accumulator: function

      the callback used to compute the result.

        • (current: U, element: T, offset: number): U | PromiseLike<T>
        • Parameters

          • current: U
          • element: T
          • offset: number

          Returns U | PromiseLike<T>

    • seed: U

      An optional seed value.

    • resultSelector: function

      An optional callback used to compute the final result.

        • (result: U, count: number): R | PromiseLike<R>
        • Parameters

          • result: U
          • count: number

          Returns R | PromiseLike<R>

    Returns Promise<R>

reduceRight

  • reduceRight<T>(source: Queryable<T>, accumulator: function): T
  • reduceRight<T, U>(source: Queryable<T>, accumulator: function, seed: U, resultSelector?: undefined | function): U
  • reduceRight<T, U, R>(source: Queryable<T>, accumulator: function, seed: U, resultSelector: function): R
  • Computes a scalar value by applying an accumulator callback over each element in reverse.

    category

    Scalar

    Type parameters

    • T

    Parameters

    • source: Queryable<T>

      A Queryable object.

    • accumulator: function

      the callback used to compute the result.

        • (current: T, element: T, offset: number): T
        • Parameters

          • current: T
          • element: T
          • offset: number

          Returns T

    Returns T

  • Computes a scalar value by applying an accumulator callback over each element in reverse.

    category

    Scalar

    Type parameters

    • T
    • U

    Parameters

    • source: Queryable<T>

      A Queryable object.

    • accumulator: function

      the callback used to compute the result.

        • (current: U, element: T, offset: number): U
        • Parameters

          • current: U
          • element: T
          • offset: number

          Returns U

    • seed: U

      An optional seed value.

    • Optional resultSelector: undefined | function

      An optional callback used to compute the final result.

    Returns U

  • Computes a scalar value by applying an accumulator callback over each element in reverse.

    category

    Scalar

    Type parameters

    • T
    • U
    • R

    Parameters

    • source: Queryable<T>

      A Queryable object.

    • accumulator: function

      the callback used to compute the result.

        • (current: U, element: T, offset: number): U
        • Parameters

          • current: U
          • element: T
          • offset: number

          Returns U

    • seed: U

      An optional seed value.

    • resultSelector: function

      An optional callback used to compute the final result.

        • (result: U, count: number): R
        • Parameters

          • result: U
          • count: number

          Returns R

    Returns R

reduceRightAsync

  • Computes a scalar value by applying an accumulator callback over each element in reverse.

    category

    Scalar

    Type parameters

    • T

    Parameters

    • source: AsyncQueryable<T>

      An AsyncQueryable object.

    • accumulator: function

      the callback used to compute the result.

        • (current: T, element: T, offset: number): T | PromiseLike<T>
        • Parameters

          • current: T
          • element: T
          • offset: number

          Returns T | PromiseLike<T>

    Returns Promise<T>

  • Computes a scalar value by applying an accumulator callback over each element in reverse.

    category

    Scalar

    Type parameters

    • T
    • U

    Parameters

    • source: AsyncQueryable<T>

      An AsyncQueryable object.

    • accumulator: function

      the callback used to compute the result.

        • (current: U, element: T, offset: number): U | PromiseLike<U>
        • Parameters

          • current: U
          • element: T
          • offset: number

          Returns U | PromiseLike<U>

    • seed: U

      An optional seed value.

    Returns Promise<U>

  • Computes a scalar value by applying an accumulator callback over each element in reverse.

    category

    Scalar

    Type parameters

    • T
    • U
    • R

    Parameters

    • source: AsyncQueryable<T>

      An AsyncQueryable object.

    • accumulator: function

      the callback used to compute the result.

        • (current: U, element: T, offset: number): U | PromiseLike<U>
        • Parameters

          • current: U
          • element: T
          • offset: number

          Returns U | PromiseLike<U>

    • seed: U

      An optional seed value.

    • resultSelector: function

      An optional callback used to compute the final result.

        • (result: U, count: number): R | PromiseLike<R>
        • Parameters

          • result: U
          • count: number

          Returns R | PromiseLike<R>

    Returns Promise<R>

single

  • single<T>(source: Queryable<T>, predicate?: function): undefined | T
  • Gets the only element, or returns undefined.

    category

    Scalar

    Type parameters

    • T

    Parameters

    • source: Queryable<T>

      A Queryable object.

    • Default value predicate: function = True

      An optional callback used to match each element.

        • (element: T): boolean
        • Parameters

          • element: T

          Returns boolean

    Returns undefined | T

singleAsync

  • Gets the only element, or returns undefined.

    category

    Scalar

    Type parameters

    • T
    • U: T

    Parameters

    • source: AsyncQueryable<T>

      An AsyncQueryable object.

    • predicate: function

      An optional callback used to match each element.

        • (element: T): boolean
        • Parameters

          • element: T

          Returns boolean

    Returns Promise<U | undefined>

  • Gets the only element, or returns undefined.

    category

    Scalar

    Type parameters

    • T

    Parameters

    • source: AsyncQueryable<T>

      An AsyncQueryable object.

    • Optional predicate: undefined | function

      An optional callback used to match each element.

    Returns Promise<T | undefined>

some

  • some<T>(source: Queryable<T>, predicate?: function): boolean
  • Computes a scalar value indicating whether source contains any elements, optionally filtering the elements using the supplied callback.

    category

    Scalar

    Type parameters

    • T

    Parameters

    • source: Queryable<T>

      A Queryable object.

    • Default value predicate: function = True

      An optional callback used to match each element.

        • (element: T): boolean
        • Parameters

          • element: T

          Returns boolean

    Returns boolean

someAsync

  • Computes a scalar value indicating whether source contains any elements, optionally filtering the elements using the supplied callback.

    category

    Scalar

    Type parameters

    • T

    Parameters

    • source: AsyncQueryable<T>

      An AsyncQueryable object.

    • Default value predicate: function = True

      An optional callback used to match each element.

        • (element: T): boolean | PromiseLike<boolean>
        • Parameters

          • element: T

          Returns boolean | PromiseLike<boolean>

    Returns Promise<boolean>

span

  • Creates a tuple whose first element is an Iterable containing the first span of elements that match the supplied predicate, and whose second element is an Iterable containing the remaining elements.

    The first Iterable is eagerly evaluated, while the second Iterable is lazily evaluated.

    category

    Scalar

    Type parameters

    • TNode
    • T: TNode
    • U: T

    Parameters

    • source: HierarchyIterable<TNode, T>

      A Queryable object.

    • predicate: function

      The predicate used to match elements.

        • (element: T): boolean
        • Parameters

          • element: T

          Returns boolean

    Returns [HierarchyIterable<TNode, U>, HierarchyIterable<TNode, T>]

  • Creates a tuple whose first element is an Iterable containing the first span of elements that match the supplied predicate, and whose second element is an Iterable containing the remaining elements.

    The first Iterable is eagerly evaluated, while the second Iterable is lazily evaluated.

    category

    Scalar

    Type parameters

    • TNode
    • T: TNode

    Parameters

    • source: HierarchyIterable<TNode, T>

      A Queryable object.

    • predicate: function

      The predicate used to match elements.

        • (element: T): boolean
        • Parameters

          • element: T

          Returns boolean

    Returns [HierarchyIterable<TNode, T>, HierarchyIterable<TNode, T>]

  • Creates a tuple whose first element is an Iterable containing the first span of elements that match the supplied predicate, and whose second element is an Iterable containing the remaining elements.

    The first Iterable is eagerly evaluated, while the second Iterable is lazily evaluated.

    category

    Scalar

    Type parameters

    • T
    • U: T

    Parameters

    • source: Queryable<T>

      A Queryable object.

    • predicate: function

      The predicate used to match elements.

        • (element: T): boolean
        • Parameters

          • element: T

          Returns boolean

    Returns [Iterable<U>, Iterable<T>]

  • Creates a tuple whose first element is an Iterable containing the first span of elements that match the supplied predicate, and whose second element is an Iterable containing the remaining elements.

    The first Iterable is eagerly evaluated, while the second Iterable is lazily evaluated.

    category

    Scalar

    Type parameters

    • T

    Parameters

    • source: Queryable<T>

      A Queryable object.

    • predicate: function

      The predicate used to match elements.

        • (element: T): boolean
        • Parameters

          • element: T

          Returns boolean

    Returns [Iterable<T>, Iterable<T>]

spanAsync

startsWith

  • Computes a scalar value indicating whether the elements of this Query start with the same sequence of elements in another Queryable.

    category

    Scalar

    Type parameters

    • T

    Parameters

    Returns boolean

  • Computes a scalar value indicating whether the elements of this Query start with the same sequence of elements in another Queryable.

    category

    Scalar

    Type parameters

    • T
    • U

    Parameters

    • left: Queryable<T>

      A Queryable object.

    • right: Queryable<U>

      A Queryable object.

    • equalityComparison: function

      A callback used to compare the equality of two elements.

        • (left: T, right: U): boolean
        • Parameters

          • left: T
          • right: U

          Returns boolean

    Returns boolean

startsWithAsync

sum

  • sum(source: Queryable<number>): number
  • sum<T>(source: Queryable<T>, elementSelector: function): number
  • Computes the sum for a series of numbers.

    category

    Scalar

    Parameters

    Returns number

  • Computes the sum for a series of numbers.

    category

    Scalar

    Type parameters

    • T

    Parameters

    • source: Queryable<T>

      A Queryable object.

    • elementSelector: function

      A callback used to convert a value in source to a number.

        • (element: T): number
        • Parameters

          • element: T

          Returns number

    Returns number

sumAsync

  • Computes the sum for a series of numbers. NOTE: If any element is not a number, this overload will throw.

    category

    Scalar

    Parameters

    Returns Promise<number>

  • Computes the sum for a series of numbers.

    category

    Scalar

    Type parameters

    • T

    Parameters

    • source: AsyncQueryable<T>

      An AsyncQueryable object.

    • elementSelector: function

      A callback used to convert a value in source to a number.

        • (element: T): number | PromiseLike<number>
        • Parameters

          • element: T

          Returns number | PromiseLike<number>

    Returns Promise<number>

toArray

  • toArray<T>(source: Queryable<T>): T[]
  • toArray<T, V>(source: Queryable<T>, elementSelector: function): V[]
  • Creates an Array for the elements of the Queryable.

    category

    Scalar

    Type parameters

    • T

    Parameters

    Returns T[]

  • Creates an Array for the elements of the Queryable.

    category

    Scalar

    Type parameters

    • T
    • V

    Parameters

    • source: Queryable<T>

      A Queryable object.

    • elementSelector: function

      A callback that selects a value for each element.

        • (element: T): V
        • Parameters

          • element: T

          Returns V

    Returns V[]

toArrayAsync

toLookup

  • toLookup<T, K>(source: Queryable<T>, keySelector: function): Lookup<K, T>
  • toLookup<T, K, V>(source: Queryable<T>, keySelector: function, elementSelector: function): Lookup<K, V>
  • Creates a Lookup for the elements of the Query.

    category

    Scalar

    Type parameters

    • T
    • K

    Parameters

    • source: Queryable<T>

      A Queryable object.

    • keySelector: function

      A callback used to select a key for each element.

        • (element: T): K
        • Parameters

          • element: T

          Returns K

    Returns Lookup<K, T>

  • Creates a Lookup for the elements of the Query.

    category

    Scalar

    Type parameters

    • T
    • K
    • V

    Parameters

    • source: Queryable<T>

      A Queryable object.

    • keySelector: function

      A callback used to select a key for each element.

        • (element: T): K
        • Parameters

          • element: T

          Returns K

    • elementSelector: function

      A callback that selects a value for each element.

        • (element: T): V
        • Parameters

          • element: T

          Returns V

    Returns Lookup<K, V>

toLookupAsync

  • Creates a Lookup for the elements of the source.

    category

    Scalar

    Type parameters

    • T
    • K

    Parameters

    • source: AsyncQueryable<T>

      An AsyncQueryable object.

    • keySelector: function

      A callback used to select a key for each element.

        • (element: T): K
        • Parameters

          • element: T

          Returns K

    Returns Promise<Lookup<K, T>>

  • Creates a Lookup for the elements of the source.

    category

    Scalar

    Type parameters

    • T
    • K
    • V

    Parameters

    • source: AsyncQueryable<T>

      An AsyncQueryable object.

    • keySelector: function

      A callback used to select a key for each element.

        • (element: T): K
        • Parameters

          • element: T

          Returns K

    • elementSelector: function

      A callback that selects a value for each element.

        • (element: T): V | PromiseLike<V>
        • Parameters

          • element: T

          Returns V | PromiseLike<V>

    Returns Promise<Lookup<K, V>>

toMap

  • toMap<T, K>(source: Queryable<T>, keySelector: function): Map<K, T>
  • toMap<T, K, V>(source: Queryable<T>, keySelector: function, elementSelector: function): Map<K, V>
  • Creates a Map for the elements of the Query.

    category

    Scalar

    Type parameters

    • T
    • K

    Parameters

    • source: Queryable<T>

      A Queryable object.

    • keySelector: function

      A callback used to select a key for each element.

        • (element: T): K
        • Parameters

          • element: T

          Returns K

    Returns Map<K, T>

  • Creates a Map for the elements of the Query.

    category

    Scalar

    Type parameters

    • T
    • K
    • V

    Parameters

    • source: Queryable<T>

      A Queryable object.

    • keySelector: function

      A callback used to select a key for each element.

        • (element: T): K
        • Parameters

          • element: T

          Returns K

    • elementSelector: function

      A callback that selects a value for each element.

        • (element: T): V
        • Parameters

          • element: T

          Returns V

    Returns Map<K, V>

toMapAsync

  • Creates a Map for the elements of the source.

    category

    Scalar

    Type parameters

    • T
    • K

    Parameters

    • source: AsyncQueryable<T>

      An AsyncQueryable object.

    • keySelector: function

      A callback used to select a key for each element.

        • (element: T): K
        • Parameters

          • element: T

          Returns K

    Returns Promise<Map<K, T>>

  • Creates a Map for the elements of the source.

    category

    Scalar

    Type parameters

    • T
    • K
    • V

    Parameters

    • source: AsyncQueryable<T>

      An AsyncQueryable object.

    • keySelector: function

      A callback used to select a key for each element.

        • (element: T): K
        • Parameters

          • element: T

          Returns K

    • elementSelector: function

      A callback that selects a value for each element.

        • (element: T): V | PromiseLike<V>
        • Parameters

          • element: T

          Returns V | PromiseLike<V>

    Returns Promise<Map<K, V>>

toObject

  • toObject<T>(source: Queryable<T>, prototype: object | null, keySelector: function): object
  • toObject<T, V>(source: Queryable<T>, prototype: object | null, keySelector: function, elementSelector: function): object
  • Creates an Object for the elements of source.

    category

    Scalar

    Type parameters

    • T

    Parameters

    • source: Queryable<T>

      A Queryable object.

    • prototype: object | null

      The prototype for the object.

    • keySelector: function

      A callback used to select a key for each element.

        • (element: T): PropertyKey
        • Parameters

          • element: T

          Returns PropertyKey

    Returns object

  • Creates an Object for the elements of source.

    category

    Scalar

    Type parameters

    • T
    • V

    Parameters

    • source: Queryable<T>

      A Queryable object.

    • prototype: object | null

      The prototype for the object.

    • keySelector: function

      A callback used to select a key for each element.

        • (element: T): PropertyKey
        • Parameters

          • element: T

          Returns PropertyKey

    • elementSelector: function

      A callback that selects a value for each element.

        • (element: T): V
        • Parameters

          • element: T

          Returns V

    Returns object

toObjectAsync

  • toObjectAsync<T>(source: AsyncQueryable<T>, prototype: object | null, keySelector: function): Promise<object>
  • toObjectAsync<T, V>(source: AsyncQueryable<T>, prototype: object | null, keySelector: function, elementSelector: function): Promise<object>
  • Creates an Object for the elements of source.

    category

    Scalar

    Type parameters

    • T

    Parameters

    • source: AsyncQueryable<T>

      An AsyncQueryable object.

    • prototype: object | null

      The prototype for the object.

    • keySelector: function

      A callback used to select a key for each element.

        • (element: T): PropertyKey
        • Parameters

          • element: T

          Returns PropertyKey

    Returns Promise<object>

  • Creates an Object for the elements of source.

    category

    Scalar

    Type parameters

    • T
    • V

    Parameters

    • source: AsyncQueryable<T>

      An AsyncQueryable object.

    • prototype: object | null

      The prototype for the object.

    • keySelector: function

      A callback used to select a key for each element.

        • (element: T): PropertyKey
        • Parameters

          • element: T

          Returns PropertyKey

    • elementSelector: function

      A callback that selects a value for each element.

        • (element: T): V | PromiseLike<V>
        • Parameters

          • element: T

          Returns V | PromiseLike<V>

    Returns Promise<object>

toSet

  • Creates a Set for the elements of the Query.

    category

    Scalar

    Type parameters

    • T

    Parameters

    Returns Set<T>

  • Creates a Set for the elements of the Query.

    category

    Scalar

    Type parameters

    • T
    • V

    Parameters

    • source: Queryable<T>

      A Queryable object.

    • elementSelector: function

      A callback that selects a value for each element.

        • (element: T): V
        • Parameters

          • element: T

          Returns V

    Returns Set<V>

toSetAsync

Functions (Subquery)

append

appendAsync

concat

concatAsync

defaultIfEmpty

defaultIfEmptyAsync

distinct

distinctAsync

do

  • Lazily invokes a callback as each element of the iterable is iterated.

    category

    Subquery

    Type parameters

    • TNode
    • T: TNode

    Parameters

    • source: HierarchyIterable<TNode, T>

      A Queryable object.

    • callback: function

      The callback to invoke.

        • (element: T, offset: number): void
        • Parameters

          • element: T
          • offset: number

          Returns void

    Returns HierarchyIterable<TNode, T>

  • Lazily invokes a callback as each element of the iterable is iterated.

    category

    Subquery

    Type parameters

    • T

    Parameters

    • source: Queryable<T>

      A Queryable object.

    • callback: function

      The callback to invoke.

        • (element: T, offset: number): void
        • Parameters

          • element: T
          • offset: number

          Returns void

    Returns Iterable<T>

doAsync

except

exceptAsync

expand

expandAsync

filter

  • Creates a HierarchyIterable whose elements match the supplied predicate.

    category

    Subquery

    Type parameters

    • TNode
    • T: TNode
    • U: T

    Parameters

    • source: HierarchyIterable<TNode, T>

      A HierarchyIterable object.

    • predicate: function

      A callback used to match each element.

        • (element: T, offset: number): boolean
        • Parameters

          • element: T
          • offset: number

          Returns boolean

    Returns HierarchyIterable<TNode, U>

  • Creates a HierarchyIterable whose elements match the supplied predicate.

    category

    Subquery

    Type parameters

    • TNode
    • U: TNode

    Parameters

    • source: HierarchyIterable<TNode>

      A HierarchyIterable object.

    • predicate: function

      A callback used to match each element.

        • (element: TNode, offset: number): boolean
        • Parameters

          • element: TNode
          • offset: number

          Returns boolean

    Returns HierarchyIterable<TNode, U>

  • Creates a HierarchyIterable whose elements match the supplied predicate.

    category

    Subquery

    Type parameters

    • TNode
    • T: TNode

    Parameters

    • source: HierarchyIterable<TNode, T>

      A HierarchyIterable object.

    • predicate: function

      A callback used to match each element.

        • (element: T, offset: number): boolean
        • Parameters

          • element: T
          • offset: number

          Returns boolean

    Returns HierarchyIterable<TNode, T>

  • Creates an Iterable whose elements match the supplied predicate.

    category

    Subquery

    Type parameters

    • T
    • U: T

    Parameters

    • source: Queryable<T>

      A HierarchyIterable object.

    • predicate: function

      A callback used to match each element.

        • (element: T, offset: number): boolean
        • Parameters

          • element: T
          • offset: number

          Returns boolean

    Returns Iterable<U>

  • Creates an Iterable whose elements match the supplied predicate.

    category

    Subquery

    Type parameters

    • T

    Parameters

    • source: Queryable<T>

      A HierarchyIterable object.

    • predicate: function

      A callback used to match each element.

        • (element: T, offset: number): boolean
        • Parameters

          • element: T
          • offset: number

          Returns boolean

    Returns Iterable<T>

filterAsync

filterDefined

filterDefinedAsync

flatMap

  • flatMap<T, U>(source: Queryable<T>, projection: function): Iterable<U>
  • flatMap<T, U, R>(source: Queryable<T>, projection: function, resultSelector: function): Iterable<R>
  • Creates an Iterable that iterates the results of applying a callback to each element of source.

    category

    Subquery

    Type parameters

    • T
    • U

    Parameters

    • source: Queryable<T>

      A Queryable object.

    • projection: function

      A callback used to map each element into an iterable.

    Returns Iterable<U>

  • Creates an Iterable that iterates the results of applying a callback to each element of source.

    category

    Subquery

    Type parameters

    • T
    • U
    • R

    Parameters

    • source: Queryable<T>

      A Queryable object.

    • projection: function

      A callback used to map each element into an iterable.

    • resultSelector: function
        • (element: T, innerElement: U): R
        • Parameters

          • element: T
          • innerElement: U

          Returns R

    Returns Iterable<R>

flatMapAsync

groupBy

  • Groups each element of a HierarchyIterable by its key.

    category

    Subquery

    Type parameters

    • TNode
    • T: TNode
    • K

    Parameters

    • source: HierarchyIterable<TNode, T>

      A HierarchyIterable object.

    • keySelector: function

      A callback used to select the key for an element.

        • (element: T): K
        • Parameters

          • element: T

          Returns K

    Returns Iterable<HierarchyGrouping<K, TNode, T>>

  • Groups each element of a Queryable by its key.

    category

    Subquery

    Type parameters

    • T
    • K

    Parameters

    • source: Queryable<T>

      A HierarchyIterable object.

    • keySelector: function

      A callback used to select the key for an element.

        • (element: T): K
        • Parameters

          • element: T

          Returns K

    Returns Iterable<Grouping<K, T>>

  • Groups each element of a Queryable by its key.

    category

    Subquery

    Type parameters

    • T
    • K
    • V

    Parameters

    • source: Queryable<T>

      A HierarchyIterable object.

    • keySelector: function

      A callback used to select the key for an element.

        • (element: T): K
        • Parameters

          • element: T

          Returns K

    • elementSelector: function

      A callback used to select a value for an element.

        • (element: T): V
        • Parameters

          • element: T

          Returns V

    Returns Iterable<Grouping<K, V>>

  • Groups each element of a Queryable by its key.

    category

    Subquery

    Type parameters

    • T
    • K
    • V
    • R

    Parameters

    • source: Queryable<T>

      A HierarchyIterable object.

    • keySelector: function

      A callback used to select the key for an element.

        • (element: T): K
        • Parameters

          • element: T

          Returns K

    • elementSelector: function

      A callback used to select a value for an element.

        • (element: T): V
        • Parameters

          • element: T

          Returns V

    • resultSelector: function

      A callback used to select a result from a group.

        • Parameters

          Returns R

    Returns Iterable<R>

groupByAsync

intersect

intersectAsync

map

  • Creates an Iterable by applying a callback to each element of a Queryable.

    category

    Subquery

    Type parameters

    • T
    • U

    Parameters

    • source: Queryable<T>

      A Queryable object.

    • selector: function

      A callback used to map each element.

        • (element: T, offset: number): U
        • Parameters

          • element: T
          • offset: number

          Returns U

    Returns Iterable<U>

mapAsync

pageBy

pageByAsync

patch

  • Creates a HierarchyIterable for the elements of source with the provided range patched into the results.

    category

    Subquery

    Type parameters

    • TNode
    • T: TNode

    Parameters

    • source: HierarchyIterable<TNode, T>

      The HierarchyIterable to patch.

    • start: number

      The offset at which to patch the range.

    • Optional skipCount: undefined | number

      The number of elements to skip from start.

    • Optional range: Queryable<T>

      The range to patch into the result.

    Returns HierarchyIterable<TNode, T>

  • Creates an Iterable for the elements of source with the provided range patched into the results.

    category

    Subquery

    Type parameters

    • T

    Parameters

    • source: Queryable<T>

      The HierarchyIterable to patch.

    • start: number

      The offset at which to patch the range.

    • Optional skipCount: undefined | number

      The number of elements to skip from start.

    • Optional range: Queryable<T>

      The range to patch into the result.

    Returns Iterable<T>

patchAsync

prepend

  • Creates a subquery for the elements of the source with the provided value prepended to the beginning.

    category

    Subquery

    Type parameters

    • TNode
    • T: TNode

    Parameters

    Returns HierarchyIterable<TNode, T>

  • Creates a subquery for the elements of the source with the provided value prepended to the beginning.

    category

    Subquery

    Type parameters

    • T

    Parameters

    • source: Queryable<T>
    • value: T

      The value to prepend.

    Returns Iterable<T>

prependAsync

relativeComplement

relativeComplementAsync

reverse

reverseAsync

scan

  • Creates a subquery containing the cumulative results of applying the provided callback to each element.

    category

    Subquery

    Type parameters

    • T

    Parameters

    • source: Queryable<T>

      A Queryable object.

    • accumulator: function

      The callback used to compute each result.

        • (current: T, element: T, offset: number): T
        • Parameters

          • current: T
          • element: T
          • offset: number

          Returns T

    Returns Iterable<T>

  • Creates a subquery containing the cumulative results of applying the provided callback to each element.

    category

    Subquery

    Type parameters

    • T
    • U

    Parameters

    • source: Queryable<T>

      A Queryable object.

    • accumulator: function

      The callback used to compute each result.

        • (current: U, element: T, offset: number): U
        • Parameters

          • current: U
          • element: T
          • offset: number

          Returns U

    • seed: U

      An optional seed value.

    Returns Iterable<U>

scanAsync

  • Creates a subquery containing the cumulative results of applying the provided callback to each element.

    category

    Subquery

    Type parameters

    • T

    Parameters

    • source: AsyncQueryable<T>

      An AsyncQueryable object.

    • accumulator: function

      The callback used to compute each result.

        • (current: T, element: T, offset: number): T | PromiseLike<T>
        • Parameters

          • current: T
          • element: T
          • offset: number

          Returns T | PromiseLike<T>

    Returns AsyncIterable<T>

  • Creates a subquery containing the cumulative results of applying the provided callback to each element.

    category

    Subquery

    Type parameters

    • T
    • U

    Parameters

    • source: AsyncQueryable<T>

      An AsyncQueryable object.

    • accumulator: function

      The callback used to compute each result.

        • (current: U, element: T, offset: number): U | PromiseLike<U>
        • Parameters

          • current: U
          • element: T
          • offset: number

          Returns U | PromiseLike<U>

    • seed: U

      An optional seed value.

    Returns AsyncIterable<U>

scanRight

  • Creates a subquery containing the cumulative results of applying the provided callback to each element in reverse.

    category

    Subquery

    Type parameters

    • T

    Parameters

    • source: Queryable<T>

      A Queryable object.

    • accumulator: function

      The callback used to compute each result.

        • (current: T, element: T, offset: number): T
        • Parameters

          • current: T
          • element: T
          • offset: number

          Returns T

    Returns Iterable<T>

  • Creates a subquery containing the cumulative results of applying the provided callback to each element in reverse.

    category

    Subquery

    Type parameters

    • T
    • U

    Parameters

    • source: Queryable<T>

      A Queryable object.

    • accumulator: function

      The callback used to compute each result.

        • (current: U, element: T, offset: number): U
        • Parameters

          • current: U
          • element: T
          • offset: number

          Returns U

    • seed: U

      An optional seed value.

    Returns Iterable<U>

scanRightAsync

  • Creates a subquery containing the cumulative results of applying the provided callback to each element in reverse.

    category

    Subquery

    Type parameters

    • T

    Parameters

    • source: AsyncQueryable<T>

      An AsyncQueryable object.

    • accumulator: function

      The callback used to compute each result.

        • (current: T, element: T, offset: number): T | PromiseLike<T>
        • Parameters

          • current: T
          • element: T
          • offset: number

          Returns T | PromiseLike<T>

    Returns AsyncIterable<T>

  • Creates a subquery containing the cumulative results of applying the provided callback to each element in reverse.

    category

    Subquery

    Type parameters

    • T
    • U

    Parameters

    • source: AsyncQueryable<T>

      An AsyncQueryable object.

    • accumulator: function

      The callback used to compute each result.

        • (current: U, element: T, offset: number): U | PromiseLike<U>
        • Parameters

          • current: U
          • element: T
          • offset: number

          Returns U | PromiseLike<U>

    • seed: U

      An optional seed value.

    Returns AsyncIterable<U>

select

  • Creates an Iterable by applying a callback to each element of a Queryable.

    category

    Subquery

    Type parameters

    • T
    • U

    Parameters

    • source: Queryable<T>

      A Queryable object.

    • selector: function

      A callback used to map each element.

        • (element: T, offset: number): U
        • Parameters

          • element: T
          • offset: number

          Returns U

    Returns Iterable<U>

selectAsync

selectMany

  • selectMany<T, U>(source: Queryable<T>, projection: function): Iterable<U>
  • selectMany<T, U, R>(source: Queryable<T>, projection: function, resultSelector: function): Iterable<R>
  • Creates an Iterable that iterates the results of applying a callback to each element of source.

    category

    Subquery

    Type parameters

    • T
    • U

    Parameters

    • source: Queryable<T>

      A Queryable object.

    • projection: function

      A callback used to map each element into an iterable.

    Returns Iterable<U>

  • Creates an Iterable that iterates the results of applying a callback to each element of source.

    category

    Subquery

    Type parameters

    • T
    • U
    • R

    Parameters

    • source: Queryable<T>

      A Queryable object.

    • projection: function

      A callback used to map each element into an iterable.

    • resultSelector: function
        • (element: T, innerElement: U): R
        • Parameters

          • element: T
          • innerElement: U

          Returns R

    Returns Iterable<R>

selectManyAsync

skip

  • Creates a subquery containing all elements except the first elements up to the supplied count.

    category

    Subquery

    Type parameters

    • TNode
    • T: TNode

    Parameters

    Returns HierarchyIterable<TNode, T>

  • Creates a subquery containing all elements except the first elements up to the supplied count.

    category

    Subquery

    Type parameters

    • T

    Parameters

    • source: Queryable<T>

      A Queryable object.

    • count: number

      The number of elements to skip.

    Returns Iterable<T>

skipAsync

skipRight

  • Creates a subquery containing all elements except the first elements up to the supplied count.

    category

    Subquery

    Type parameters

    • TNode
    • T: TNode

    Parameters

    Returns HierarchyIterable<TNode, T>

  • Creates a subquery containing all elements except the first elements up to the supplied count.

    category

    Subquery

    Type parameters

    • T

    Parameters

    • source: Queryable<T>

      A Queryable object.

    • count: number

      The number of elements to skip.

    Returns Iterable<T>

skipRightAsync

skipUntil

  • Creates a subquery containing all elements except the first elements that do not match the supplied predicate.

    category

    Subquery

    Type parameters

    • TNode
    • T: TNode

    Parameters

    • source: HierarchyIterable<TNode, T>

      A Queryable object.

    • predicate: function

      A callback used to match each element.

        • (element: T): boolean
        • Parameters

          • element: T

          Returns boolean

    Returns HierarchyIterable<TNode, T>

  • Creates a subquery containing all elements except the first elements that do not match the supplied predicate.

    category

    Subquery

    Type parameters

    • T

    Parameters

    • source: Queryable<T>

      A Queryable object.

    • predicate: function

      A callback used to match each element.

        • (element: T): boolean
        • Parameters

          • element: T

          Returns boolean

    Returns Iterable<T>

skipUntilAsync

  • Creates a subquery containing all elements except the first elements that do not match the supplied predicate.

    category

    Subquery

    Type parameters

    • TNode
    • T: TNode

    Parameters

    • source: PossiblyAsyncHierarchyIterable<TNode, T>

      An AsyncQueryable object.

    • predicate: function

      A callback used to match each element.

        • (element: T): boolean | PromiseLike<boolean>
        • Parameters

          • element: T

          Returns boolean | PromiseLike<boolean>

    Returns AsyncHierarchyIterable<TNode, T>

  • Creates a subquery containing all elements except the first elements that do not match the supplied predicate.

    category

    Subquery

    Type parameters

    • T

    Parameters

    • source: AsyncQueryable<T>

      An AsyncQueryable object.

    • predicate: function

      A callback used to match each element.

        • (element: T): boolean | PromiseLike<boolean>
        • Parameters

          • element: T

          Returns boolean | PromiseLike<boolean>

    Returns AsyncIterable<T>

skipWhile

  • Creates a subquery containing all elements except the first elements that match the supplied predicate.

    category

    Subquery

    Type parameters

    • TNode
    • T: TNode

    Parameters

    • source: HierarchyIterable<TNode, T>

      A Queryable object.

    • predicate: function

      A callback used to match each element.

        • (element: T): boolean
        • Parameters

          • element: T

          Returns boolean

    Returns HierarchyIterable<TNode, T>

  • Creates a subquery containing all elements except the first elements that match the supplied predicate.

    category

    Subquery

    Type parameters

    • T

    Parameters

    • source: Queryable<T>

      A Queryable object.

    • predicate: function

      A callback used to match each element.

        • (element: T): boolean
        • Parameters

          • element: T

          Returns boolean

    Returns Iterable<T>

skipWhileAsync

  • Creates a subquery containing all elements except the first elements that match the supplied predicate.

    category

    Subquery

    Type parameters

    • TNode
    • T: TNode

    Parameters

    • source: PossiblyAsyncHierarchyIterable<TNode, T>

      An AsyncQueryable object.

    • predicate: function

      A callback used to match each element.

        • (element: T): boolean | PromiseLike<boolean>
        • Parameters

          • element: T

          Returns boolean | PromiseLike<boolean>

    Returns AsyncHierarchyIterable<TNode, T>

  • Creates a subquery containing all elements except the first elements that match the supplied predicate.

    category

    Subquery

    Type parameters

    • T

    Parameters

    • source: AsyncQueryable<T>

      An AsyncQueryable object.

    • predicate: function

      A callback used to match each element.

        • (element: T): boolean | PromiseLike<boolean>
        • Parameters

          • element: T

          Returns boolean | PromiseLike<boolean>

    Returns AsyncIterable<T>

spanMap

  • Creates a subquery whose elements are the contiguous ranges of elements that share the same key.

    category

    Subquery

    Type parameters

    • TNode
    • T: TNode
    • K

    Parameters

    • source: HierarchyIterable<TNode, T>

      A Queryable object.

    • keySelector: function

      A callback used to select the key for an element.

        • (element: T): K
        • Parameters

          • element: T

          Returns K

    Returns Iterable<HierarchyGrouping<K, TNode, T>>

  • Creates a subquery whose elements are the contiguous ranges of elements that share the same key.

    category

    Subquery

    Type parameters

    • T
    • K

    Parameters

    • source: Queryable<T>

      A Queryable object.

    • keySelector: function

      A callback used to select the key for an element.

        • (element: T): K
        • Parameters

          • element: T

          Returns K

    Returns Iterable<Grouping<K, T>>

  • Creates a subquery whose values are computed from each element of the contiguous ranges of elements that share the same key.

    category

    Subquery

    Type parameters

    • T
    • K
    • V

    Parameters

    • source: Queryable<T>

      A Queryable object.

    • keySelector: function

      A callback used to select the key for an element.

        • (element: T): K
        • Parameters

          • element: T

          Returns K

    • elementSelector: function

      A callback used to select a value for an element.

        • (element: T): V
        • Parameters

          • element: T

          Returns V

    Returns Iterable<Grouping<K, V>>

  • Creates a subquery whose values are computed from the contiguous ranges of elements that share the same key.

    category

    Subquery

    Type parameters

    • T
    • K
    • V
    • R

    Parameters

    • source: Queryable<T>

      A Queryable object.

    • keySelector: function

      A callback used to select the key for an element.

        • (element: T): K
        • Parameters

          • element: T

          Returns K

    • elementSelector: function

      A callback used to select a value for an element.

        • (element: T): V
        • Parameters

          • element: T

          Returns V

    • spanSelector: function

      A callback used to select a result from a contiguous range.

        • Parameters

          Returns R

    Returns Iterable<R>

spanMapAsync

  • Creates a subquery whose elements are the contiguous ranges of elements that share the same key.

    category

    Subquery

    Type parameters

    • TNode
    • T: TNode
    • K

    Parameters

    Returns AsyncIterable<HierarchyGrouping<K, TNode, T>>

  • Creates a subquery whose elements are the contiguous ranges of elements that share the same key.

    category

    Subquery

    Type parameters

    • T
    • K

    Parameters

    • source: AsyncQueryable<T>

      An AsyncQueryable object.

    • keySelector: function

      A callback used to select the key for an element.

        • (element: T): K
        • Parameters

          • element: T

          Returns K

    Returns AsyncIterable<Grouping<K, T>>

  • Creates a subquery whose values are computed from each element of the contiguous ranges of elements that share the same key.

    category

    Subquery

    Type parameters

    • T
    • K
    • V

    Parameters

    • source: AsyncQueryable<T>

      An AsyncQueryable object.

    • keySelector: function

      A callback used to select the key for an element.

        • (element: T): K
        • Parameters

          • element: T

          Returns K

    • elementSelector: function

      A callback used to select a value for an element.

        • (element: T): V | PromiseLike<V>
        • Parameters

          • element: T

          Returns V | PromiseLike<V>

    Returns AsyncIterable<Grouping<K, V>>

  • Creates a subquery whose values are computed from the contiguous ranges of elements that share the same key.

    category

    Subquery

    Type parameters

    • T
    • K
    • V
    • R

    Parameters

    • source: AsyncQueryable<T>

      An AsyncQueryable object.

    • keySelector: function

      A callback used to select the key for an element.

        • (element: T): K
        • Parameters

          • element: T

          Returns K

    • elementSelector: function

      A callback used to select a value for an element.

        • (element: T): V | PromiseLike<V>
        • Parameters

          • element: T

          Returns V | PromiseLike<V>

    • spanSelector: function

      A callback used to select a result from a contiguous range.

        • (key: K, elements: Iterable<V>): R | PromiseLike<R>
        • Parameters

          Returns R | PromiseLike<R>

    Returns AsyncIterable<R>

symmetricDifference

symmetricDifferenceAsync

take

  • Creates a subquery containing the first elements up to the supplied count.

    category

    Subquery

    Type parameters

    • TNode
    • T: TNode

    Parameters

    Returns HierarchyIterable<TNode, T>

  • Creates a subquery containing the first elements up to the supplied count.

    category

    Subquery

    Type parameters

    • T

    Parameters

    • source: Queryable<T>

      A Queryable object.

    • count: number

      The number of elements to take.

    Returns Iterable<T>

takeAsync

takeRight

  • Creates a subquery containing the last elements up to the supplied count.

    category

    Subquery

    Type parameters

    • TNode
    • T: TNode

    Parameters

    Returns HierarchyIterable<TNode, T>

  • Creates a subquery containing the last elements up to the supplied count.

    category

    Subquery

    Type parameters

    • T

    Parameters

    • source: Queryable<T>

      A Queryable object.

    • count: number

      The number of elements to take.

    Returns Iterable<T>

takeRightAsync

takeUntil

  • Creates a subquery containing the first elements that do not match the supplied predicate.

    category

    Subquery

    Type parameters

    • TNode
    • T: TNode
    • U: T

    Parameters

    • source: HierarchyIterable<TNode, T>

      A Queryable object.

    • predicate: function

      A callback used to match each element.

        • (element: T): boolean
        • Parameters

          • element: T

          Returns boolean

    Returns HierarchyIterable<TNode, U>

  • Creates a subquery containing the first elements that do not match the supplied predicate.

    category

    Subquery

    Type parameters

    • TNode
    • T: TNode

    Parameters

    • source: HierarchyIterable<TNode, T>

      A Queryable object.

    • predicate: function

      A callback used to match each element.

        • (element: T): boolean
        • Parameters

          • element: T

          Returns boolean

    Returns HierarchyIterable<TNode, T>

  • Creates a subquery containing the first elements that do not match the supplied predicate.

    category

    Subquery

    Type parameters

    • T
    • U: T

    Parameters

    • source: Queryable<T>

      A Queryable object.

    • predicate: function

      A callback used to match each element.

        • (element: T): boolean
        • Parameters

          • element: T

          Returns boolean

    Returns Iterable<U>

  • Creates a subquery containing the first elements that do not match the supplied predicate.

    category

    Subquery

    Type parameters

    • T

    Parameters

    • source: Queryable<T>

      A Queryable object.

    • predicate: function

      A callback used to match each element.

        • (element: T): boolean
        • Parameters

          • element: T

          Returns boolean

    Returns Iterable<T>

takeUntilAsync

  • Creates a subquery containing the first elements that do not match the supplied predicate.

    category

    Subquery

    Type parameters

    • TNode
    • T: TNode
    • U: T

    Parameters

    Returns AsyncHierarchyIterable<TNode, U>

  • Creates a subquery containing the first elements that do not match the supplied predicate.

    category

    Subquery

    Type parameters

    • TNode
    • T: TNode

    Parameters

    • source: PossiblyAsyncHierarchyIterable<TNode, T>

      An AsyncQueryable object.

    • predicate: function

      A callback used to match each element.

        • (element: T): boolean | PromiseLike<boolean>
        • Parameters

          • element: T

          Returns boolean | PromiseLike<boolean>

    Returns AsyncHierarchyIterable<TNode, T>

  • Creates a subquery containing the first elements that do not match the supplied predicate.

    category

    Subquery

    Type parameters

    • T
    • U: T

    Parameters

    • source: AsyncQueryable<T>

      An AsyncQueryable object.

    • predicate: function

      A callback used to match each element.

        • (element: T): boolean
        • Parameters

          • element: T

          Returns boolean

    Returns AsyncIterable<U>

  • Creates a subquery containing the first elements that do not match the supplied predicate.

    category

    Subquery

    Type parameters

    • T

    Parameters

    • source: AsyncQueryable<T>

      An AsyncQueryable object.

    • predicate: function

      A callback used to match each element.

        • (element: T): boolean | PromiseLike<boolean>
        • Parameters

          • element: T

          Returns boolean | PromiseLike<boolean>

    Returns AsyncIterable<T>

takeWhile

  • Creates a subquery containing the first elements that match the supplied predicate.

    category

    Subquery

    Type parameters

    • TNode
    • T: TNode
    • U: T

    Parameters

    • source: HierarchyIterable<TNode, T>

      A Queryable object.

    • predicate: function

      A callback used to match each element.

        • (element: T): boolean
        • Parameters

          • element: T

          Returns boolean

    Returns HierarchyIterable<TNode, U>

  • Creates a subquery containing the first elements that match the supplied predicate.

    category

    Subquery

    Type parameters

    • TNode
    • T: TNode

    Parameters

    • source: HierarchyIterable<TNode, T>

      A Queryable object.

    • predicate: function

      A callback used to match each element.

        • (element: T): boolean
        • Parameters

          • element: T

          Returns boolean

    Returns HierarchyIterable<TNode, T>

  • Creates a subquery containing the first elements that match the supplied predicate.

    category

    Subquery

    Type parameters

    • T
    • U: T

    Parameters

    • source: Queryable<T>

      A Queryable object.

    • predicate: function

      A callback used to match each element.

        • (element: T): boolean
        • Parameters

          • element: T

          Returns boolean

    Returns Iterable<U>

  • Creates a subquery containing the first elements that match the supplied predicate.

    category

    Subquery

    Type parameters

    • T

    Parameters

    • source: Queryable<T>

      A Queryable object.

    • predicate: function

      A callback used to match each element.

        • (element: T): boolean
        • Parameters

          • element: T

          Returns boolean

    Returns Iterable<T>

takeWhileAsync

  • Creates a subquery containing the first elements that match the supplied predicate.

    category

    Subquery

    Type parameters

    • TNode
    • T: TNode
    • U: T

    Parameters

    Returns AsyncHierarchyIterable<TNode, U>

  • Creates a subquery containing the first elements that match the supplied predicate.

    category

    Subquery

    Type parameters

    • TNode
    • T: TNode

    Parameters

    • source: PossiblyAsyncHierarchyIterable<TNode, T>

      An AsyncQueryable object.

    • predicate: function

      A callback used to match each element.

        • (element: T): boolean | PromiseLike<boolean>
        • Parameters

          • element: T

          Returns boolean | PromiseLike<boolean>

    Returns AsyncHierarchyIterable<TNode, T>

  • Creates a subquery containing the first elements that match the supplied predicate.

    category

    Subquery

    Type parameters

    • T
    • U: T

    Parameters

    • source: AsyncQueryable<T>

      An AsyncQueryable object.

    • predicate: function

      A callback used to match each element.

        • (element: T): boolean
        • Parameters

          • element: T

          Returns boolean

    Returns AsyncIterable<U>

  • Creates a subquery containing the first elements that match the supplied predicate.

    category

    Subquery

    Type parameters

    • T

    Parameters

    • source: AsyncQueryable<T>

      An AsyncQueryable object.

    • predicate: function

      A callback used to match each element.

        • (element: T): boolean | PromiseLike<boolean>
        • Parameters

          • element: T

          Returns boolean | PromiseLike<boolean>

    Returns AsyncIterable<T>

tap

  • Lazily invokes a callback as each element of the iterable is iterated.

    category

    Subquery

    Type parameters

    • TNode
    • T: TNode

    Parameters

    • source: HierarchyIterable<TNode, T>

      A Queryable object.

    • callback: function

      The callback to invoke.

        • (element: T, offset: number): void
        • Parameters

          • element: T
          • offset: number

          Returns void

    Returns HierarchyIterable<TNode, T>

  • Lazily invokes a callback as each element of the iterable is iterated.

    category

    Subquery

    Type parameters

    • T

    Parameters

    • source: Queryable<T>

      A Queryable object.

    • callback: function

      The callback to invoke.

        • (element: T, offset: number): void
        • Parameters

          • element: T
          • offset: number

          Returns void

    Returns Iterable<T>

tapAsync

  • Lazily invokes a callback as each element of the iterable is iterated.

    category

    Subquery

    Type parameters

    • TNode
    • T: TNode

    Parameters

    Returns AsyncHierarchyIterable<TNode, T>

  • Lazily invokes a callback as each element of the iterable is iterated.

    category

    Subquery

    Type parameters

    • TNode
    • T: TNode

    Parameters

    • source: PossiblyAsyncHierarchyIterable<TNode, T>

      An AsyncQueryable object.

    • callback: function

      The callback to invoke.

        • (element: T, offset: number): PromiseLike<void>
        • Parameters

          • element: T
          • offset: number

          Returns PromiseLike<void>

    Returns AsyncHierarchyIterable<TNode, T>

  • Lazily invokes a callback as each element of the iterable is iterated.

    category

    Subquery

    Type parameters

    • TNode
    • T: TNode

    Parameters

    • source: PossiblyAsyncHierarchyIterable<TNode, T>

      An AsyncQueryable object.

    • callback: function

      The callback to invoke.

        • (element: T, offset: number): PromiseLike<void> | void
        • Parameters

          • element: T
          • offset: number

          Returns PromiseLike<void> | void

    Returns AsyncHierarchyIterable<TNode, T>

  • Lazily invokes a callback as each element of the iterable is iterated.

    category

    Subquery

    Type parameters

    • T

    Parameters

    • source: AsyncQueryable<T>

      An AsyncQueryable object.

    • callback: function

      The callback to invoke.

        • (element: T, offset: number): void
        • Parameters

          • element: T
          • offset: number

          Returns void

    Returns AsyncIterable<T>

  • Lazily invokes a callback as each element of the iterable is iterated.

    category

    Subquery

    Type parameters

    • T

    Parameters

    • source: AsyncQueryable<T>

      An AsyncQueryable object.

    • callback: function

      The callback to invoke.

        • (element: T, offset: number): PromiseLike<void>
        • Parameters

          • element: T
          • offset: number

          Returns PromiseLike<void>

    Returns AsyncIterable<T>

  • Lazily invokes a callback as each element of the iterable is iterated.

    category

    Subquery

    Type parameters

    • T

    Parameters

    • source: AsyncQueryable<T>

      An AsyncQueryable object.

    • callback: function

      The callback to invoke.

        • (element: T, offset: number): PromiseLike<void> | void
        • Parameters

          • element: T
          • offset: number

          Returns PromiseLike<void> | void

    Returns AsyncIterable<T>

through

  • through<T, S, R>(source: S, callback: function): R
  • Pass the entire source to the provided callback, returning a Queryable from the result.

    category

    Subquery

    Type parameters

    Parameters

    • source: S

      A Queryable object.

    • callback: function

      A callback function.

        • (source: S): R
        • Parameters

          • source: S

          Returns R

    Returns R

throughAsync

  • throughAsync<T, S, R>(source: S, callback: function): R

union

unionAsync

where

whereAsync

whereDefined

whereDefinedAsync

xor

xorAsync

Functions (Order)

orderBy

  • Creates an OrderedHierarchyIterable whose elements are sorted in ascending order by the provided key.

    category

    Order

    Type parameters

    • TNode
    • T: TNode
    • K

    Parameters

    • source: HierarchyIterable<TNode, T>

      A HierarchyIterable object.

    • keySelector: function

      A callback used to select the key for an element.

        • (element: T): K
        • Parameters

          • element: T

          Returns K

    • Optional comparison: undefined | function

      An optional callback used to compare two keys.

    Returns OrderedHierarchyIterable<TNode, T>

  • Creates an OrderedIterable whose elements are sorted in ascending order by the provided key.

    category

    Order

    Type parameters

    • T
    • K

    Parameters

    • source: Queryable<T>

      A HierarchyIterable object.

    • keySelector: function

      A callback used to select the key for an element.

        • (element: T): K
        • Parameters

          • element: T

          Returns K

    • Optional comparison: undefined | function

      An optional callback used to compare two keys.

    Returns OrderedIterable<T>

orderByAsync

orderByDescending

  • Creates an OrderedHierarchyIterable whose elements are sorted in descending order by the provided key.

    category

    Order

    Type parameters

    • TNode
    • T: TNode
    • K

    Parameters

    • source: HierarchyIterable<TNode, T>

      A HierarchyIterable object.

    • keySelector: function

      A callback used to select the key for an element.

        • (element: T): K
        • Parameters

          • element: T

          Returns K

    • Optional comparison: undefined | function

      An optional callback used to compare two keys.

    Returns OrderedHierarchyIterable<TNode, T>

  • Creates an OrderedIterable whose elements are sorted in descending order by the provided key.

    category

    Order

    Type parameters

    • T
    • K

    Parameters

    • source: Queryable<T>

      A HierarchyIterable object.

    • keySelector: function

      A callback used to select the key for an element.

        • (element: T): K
        • Parameters

          • element: T

          Returns K

    • Optional comparison: undefined | function

      An optional callback used to compare two keys.

    Returns OrderedIterable<T>

orderByDescendingAsync

thenBy

  • Creates a subsequent OrderedHierarchyIterable whose elements are also sorted in ascending order by the provided key.

    category

    Order

    Type parameters

    • TNode
    • T: TNode
    • K

    Parameters

    • source: OrderedHierarchyIterable<TNode, T>
    • keySelector: function

      A callback used to select the key for an element.

        • (element: T): K
        • Parameters

          • element: T

          Returns K

    • Optional comparison: undefined | function

      An optional callback used to compare two keys.

    Returns OrderedHierarchyIterable<TNode, T>

  • Creates a subsequent OrderedIterable whose elements are also sorted in ascending order by the provided key.

    category

    Order

    Type parameters

    • T
    • K

    Parameters

    • source: OrderedIterable<T>
    • keySelector: function

      A callback used to select the key for an element.

        • (element: T): K
        • Parameters

          • element: T

          Returns K

    • Optional comparison: undefined | function

      An optional callback used to compare two keys.

    Returns OrderedIterable<T>

thenByAsync

thenByDescending

  • Creates a subsequent OrderedHierarchyIterable whose elements are also sorted in descending order by the provided key.

    category

    Order

    Type parameters

    • TNode
    • T: TNode
    • K

    Parameters

    • source: OrderedHierarchyIterable<TNode, T>
    • keySelector: function

      A callback used to select the key for an element.

        • (element: T): K
        • Parameters

          • element: T

          Returns K

    • Optional comparison: undefined | function

      An optional callback used to compare two keys.

    Returns OrderedHierarchyIterable<TNode, T>

  • Creates a subsequent OrderedIterable whose elements are also sorted in descending order by the provided key.

    category

    Order

    Type parameters

    • T
    • K

    Parameters

    • source: OrderedIterable<T>
    • keySelector: function

      A callback used to select the key for an element.

        • (element: T): K
        • Parameters

          • element: T

          Returns K

    • Optional comparison: undefined | function

      An optional callback used to compare two keys.

    Returns OrderedIterable<T>

thenByDescendingAsync

Functions (Join)

fullJoin

  • fullJoin<O, I, K, R>(outer: Queryable<O>, inner: Queryable<I>, outerKeySelector: function, innerKeySelector: function, resultSelector: function): Iterable<R>
  • Creates an Iterable for the correlated elements between an outer Queryable object and an inner Queryable object.

    category

    Join

    Type parameters

    • O
    • I
    • K
    • R

    Parameters

    • outer: Queryable<O>

      A Queryable object.

    • inner: Queryable<I>

      A Queryable object.

    • outerKeySelector: function

      A callback used to select the key for an element in outer.

        • (element: O): K
        • Parameters

          • element: O

          Returns K

    • innerKeySelector: function

      A callback used to select the key for an element in inner.

        • (element: I): K
        • Parameters

          • element: I

          Returns K

    • resultSelector: function

      A callback used to select the result for the correlated elements.

        • (outer: O | undefined, inner: I | undefined): R
        • Parameters

          • outer: O | undefined
          • inner: I | undefined

          Returns R

    Returns Iterable<R>

fullJoinAsync

  • Creates an AsyncIterable for the correlated elements between an outer AsyncQueryable object and an inner AsyncQueryable object.

    category

    Join

    Type parameters

    • O
    • I
    • K
    • R

    Parameters

    • outer: AsyncQueryable<O>

      An AsyncQueryable object.

    • inner: AsyncQueryable<I>

      An AsyncQueryable object.

    • outerKeySelector: function

      A callback used to select the key for an element in outer.

        • (element: O): K
        • Parameters

          • element: O

          Returns K

    • innerKeySelector: function

      A callback used to select the key for an element in inner.

        • (element: I): K
        • Parameters

          • element: I

          Returns K

    • resultSelector: function

      A callback used to select the result for the correlated elements.

        • (outer: O | undefined, inner: I | undefined): R | PromiseLike<R>
        • Parameters

          • outer: O | undefined
          • inner: I | undefined

          Returns R | PromiseLike<R>

    Returns AsyncIterable<R>

groupJoin

  • groupJoin<O, I, K, R>(outer: Queryable<O>, inner: Queryable<I>, outerKeySelector: function, innerKeySelector: function, resultSelector: function): Iterable<R>
  • Creates a grouped Iterable for the correlated elements between an outer Queryable object and an inner Queryable object.

    category

    Join

    Type parameters

    • O
    • I
    • K
    • R

    Parameters

    • outer: Queryable<O>

      A Queryable object.

    • inner: Queryable<I>

      A Queryable object.

    • outerKeySelector: function

      A callback used to select the key for an element in outer.

        • (element: O): K
        • Parameters

          • element: O

          Returns K

    • innerKeySelector: function

      A callback used to select the key for an element in inner.

        • (element: I): K
        • Parameters

          • element: I

          Returns K

    • resultSelector: function

      A callback used to select the result for the correlated elements.

        • Parameters

          Returns R

    Returns Iterable<R>

groupJoinAsync

  • Creates a grouped AsyncIterable for the correlated elements between an outer AsyncQueryable object and an inner AsyncQueryable object.

    category

    Join

    Type parameters

    • O
    • I
    • K
    • R

    Parameters

    • outer: AsyncQueryable<O>

      An AsyncQueryable object.

    • inner: AsyncQueryable<I>

      An AsyncQueryable object.

    • outerKeySelector: function

      A callback used to select the key for an element in outer.

        • (element: O): K
        • Parameters

          • element: O

          Returns K

    • innerKeySelector: function

      A callback used to select the key for an element in inner.

        • (element: I): K
        • Parameters

          • element: I

          Returns K

    • resultSelector: function

      A callback used to select the result for the correlated elements.

        • (outer: O, inner: Iterable<I>): R | PromiseLike<R>
        • Parameters

          Returns R | PromiseLike<R>

    Returns AsyncIterable<R>

join

  • join<O, I, K, R>(outer: Queryable<O>, inner: Queryable<I>, outerKeySelector: function, innerKeySelector: function, resultSelector: function): Iterable<R>
  • Creates an Iterable for the correlated elements of two Queryable objects.

    category

    Join

    Type parameters

    • O
    • I
    • K
    • R

    Parameters

    • outer: Queryable<O>

      A Queryable object.

    • inner: Queryable<I>

      A Queryable object.

    • outerKeySelector: function

      A callback used to select the key for an element in outer.

        • (element: O): K
        • Parameters

          • element: O

          Returns K

    • innerKeySelector: function

      A callback used to select the key for an element in inner.

        • (element: I): K
        • Parameters

          • element: I

          Returns K

    • resultSelector: function

      A callback used to select the result for the correlated elements.

        • (outer: O, inner: I): R
        • Parameters

          • outer: O
          • inner: I

          Returns R

    Returns Iterable<R>

joinAsync

  • Creates an AsyncIterable for the correlated elements of two AsyncQueryable objects.

    category

    Join

    Type parameters

    • O
    • I
    • K
    • R

    Parameters

    • outer: AsyncQueryable<O>
    • inner: AsyncQueryable<I>
    • outerKeySelector: function

      A callback used to select the key for an element in outer.

        • (element: O): K
        • Parameters

          • element: O

          Returns K

    • innerKeySelector: function

      A callback used to select the key for an element in inner.

        • (element: I): K
        • Parameters

          • element: I

          Returns K

    • resultSelector: function

      A callback used to select the result for the correlated elements.

        • (outer: O, inner: I): R | PromiseLike<R>
        • Parameters

          • outer: O
          • inner: I

          Returns R | PromiseLike<R>

    Returns AsyncIterable<R>

zip

  • Creates a subquery that combines two Queryable objects by combining elements in tuples.

    category

    Join

    Type parameters

    • T
    • U

    Parameters

    Returns Iterable<[T, U]>

  • Creates a subquery that combines two Queryable objects by combining elements using the supplied callback.

    category

    Join

    Type parameters

    • T
    • U
    • R

    Parameters

    • left: Queryable<T>
    • right: Queryable<U>
    • selector: function

      A callback used to combine two elements.

        • (left: T, right: U): R
        • Parameters

          • left: T
          • right: U

          Returns R

    Returns Iterable<R>

zipAsync

Functions (Hierarchy)

ancestors

ancestorsAndSelf

ancestorsAndSelfAsync

ancestorsAsync

bottomMost

bottomMostAsync

children

childrenAsync

descendants

descendantsAndSelf

descendantsAndSelfAsync

descendantsAsync

hierarchy

hierarchyAsync

nthChild

nthChildAsync

parents

parentsAsync

root

rootAsync

self

selfAsync

siblings

siblingsAfterSelf

siblingsAfterSelfAsync

siblingsAndSelf

siblingsAndSelfAsync

siblingsAsync

siblingsBeforeSelf

siblingsBeforeSelfAsync

toHierarchy

toHierarchyAsync

topMost

  • Creates a HierarchyIterable for the top-most elements. Elements that are a descendant of any other element are removed.

    category

    Hierarchy

    Type parameters

    • TNode
    • T: TNode
    • U: T

    Parameters

    • source: HierarchyIterable<TNode, T>

      A HierarchyIterable object.

    • predicate: function

      An optional callback used to filter the results.

        • (value: T): boolean
        • Parameters

          • value: T

          Returns boolean

    Returns HierarchyIterable<TNode, U>

  • Creates a HierarchyIterable for the top-most elements. Elements that are a descendant of any other element are removed.

    category

    Hierarchy

    Type parameters

    • TNode
    • T: TNode

    Parameters

    Returns HierarchyIterable<TNode, T>

topMostAsync

Generated using TypeDoc