Creates a Query
that iterates the elements from sources picked from a list based on the
result of a lazily evaluated choice.
A callback used to choose a source.
A list of sources
A default source to use when another choice could not be made.
Creates a Query
that, when iterated, consumes the provided Iterator
.
An Iterator
object.
Creates a Query
that repeats the provided value forever.
The value for each element of the Query
.
Creates a Query
with no elements.
Creates a Query
from a Queryable source.
A Queryable object.
Creates a Query
from a Queryable source.
A Queryable object.
Creates a Query
from a Queryable source.
A Queryable object.
Creates a Query
from a Queryable source.
Creates a Query
from a Queryable source.
A Queryable object.
A HierarchyProvider
object.
Creates a Query
from a Queryable source.
A Queryable object.
A HierarchyProvider
object.
Creates a Query
whose values are provided by a callback executed a provided number of
times.
The number of times to execute the callback.
The callback to execute.
Creates a HierarchyQuery from a root node and a HierarchyProvider.
The root node of the hierarchy.
A HierarchyProvider
object.
Creates a Query
that iterates the elements from one of two sources based on the result of a
lazily evaluated condition.
A callback used to choose a source.
The source to use when the callback evaluates to true
.
The source to use when the callback evaluates to false
.
Creates a Query
for the own property key-value pairs of an object.
An object.
Creates a Query
for the own property keys of an object.
An object.
Creates a Query
for the own property values of an object.
An object.
Creates a Query
for the provided elements.
The elements of the Query
.
Creates a Query
over a single element.
The only element for the Query
.
Creates a Query
over a range of numbers.
The starting number of the range.
The ending number of the range.
The amount by which to change between each itereated value.
Creates a Query
for a value repeated a provided number of times.
The value for each element of the Query
.
The number of times to repeat the value.
Computes the average for a series of numbers.
Computes the average for a series of numbers.
Creates a tuple whose first element is a subquery containing the first span of elements that do not match the supplied predicate, and whose second element is a subquery containing the remaining elements.
The first subquery is eagerly evaluated, while the second subquery is lazily evaluated.
The predicate used to match elements.
Computes a scalar value indicating whether every element in this Query
corresponds to a matching element
in another Queryable at the same position.
Computes a scalar value indicating whether every element in this Query
corresponds to a matching element
in another Queryable at the same position.
A Queryable object.
An optional callback used to compare the equality of two elements.
Counts the number of elements in the Query, optionally filtering elements using the supplied callback.
An optional callback used to match each element.
Iterates over all of the elements in the query, ignoring the results.
Finds the value in the Query at the provided offset. A negative offset starts from the last element.
An offset.
Computes a scalar value indicating whether the elements of this Query
end
with the same sequence of elements in another Queryable.
Computes a scalar value indicating whether the elements of this Query
end
with the same sequence of elements in another Queryable.
A Queryable object.
A callback used to compare the equality of two elements.
Eagerly evaluate the query, returning a new Query
.
Computes a scalar value indicating whether all elements of the Query match the supplied callback.
A callback used to match each element.
Computes a scalar value indicating whether all elements of the Query match the supplied callback.
A callback used to match each element.
Gets the first element in the Query, optionally filtering elements using the supplied callback.
An optional callback used to match each element.
Gets the first element in the Query, optionally filtering elements using the supplied callback.
An optional callback used to match each element.
Invokes a callback for each element of the query.
The callback to invoke.
Computes a scalar value indicating whether the provided value is included in the query.
A value.
Computes a scalar value indicating whether the provided value is included in the query.
A value.
An optional callback used to compare the equality of two elements.
Computes a scalar value indicating whether the elements of this Query
include
an exact sequence of elements from another Queryable.
Computes a scalar value indicating whether the elements of this Query
include
an exact sequence of elements from another Queryable.
A Queryable object.
A callback used to compare the equality of two elements.
Gets the last element in the Query, optionally filtering elements using the supplied callback.
An optional callback used to match each element.
Gets the last element in the Query, optionally filtering elements using the supplied callback.
An optional callback used to match each element.
Gets the maximum element in the query, optionally comparing elements using the supplied callback.
An optional callback used to compare two elements.
Gets the minimum element in the query, optionally comparing elements using the supplied callback.
An optional callback used to compare two elements.
Finds the value in the Query at the provided offset. A negative offset starts from the last element.
This is an alias for elementAt
.
An offset.
Computes a scalar value by applying an accumulator callback over each element.
the callback used to compute the result.
Computes a scalar value by applying an accumulator callback over each element.
the callback used to compute the result.
An optional seed value.
An optional callback used to compute the final result.
Computes a scalar value by applying an accumulator callback over each element.
the callback used to compute the result.
An optional seed value.
An optional callback used to compute the final result.
Computes a scalar value by applying an accumulator callback over each element in reverse.
the callback used to compute the result.
Computes a scalar value by applying an accumulator callback over each element in reverse.
the callback used to compute the result.
An optional seed value.
An optional callback used to compute the final result.
Computes a scalar value by applying an accumulator callback over each element in reverse.
the callback used to compute the result.
An optional seed value.
An optional callback used to compute the final result.
Gets the only element in the Query, or returns undefined.
An optional callback used to match each element.
Gets the only element in the Query, or returns undefined.
An optional callback used to match each element.
Computes a scalar value indicating whether the Query contains any elements, optionally filtering the elements using the supplied callback.
An optional callback used to match each element.
Creates a tuple whose first element is a subquery containing the first span of elements that match the supplied predicate, and whose second element is a subquery containing the remaining elements.
The first subquery is eagerly evaluated, while the second subquery is lazily evaluated.
The predicate used to match elements.
Creates a tuple whose first element is a subquery containing the first span of elements that match the supplied predicate, and whose second element is a subquery containing the remaining elements.
The first subquery is eagerly evaluated, while the second subquery is lazily evaluated.
The predicate used to match elements.
Computes a scalar value indicating whether the elements of this Query
start
with the same sequence of elements in another Queryable.
Computes a scalar value indicating whether the elements of this Query
start
with the same sequence of elements in another Queryable.
A Queryable object.
A callback used to compare the equality of two elements.
Computes the sum for a series of numbers.
Computes the sum for a series of numbers.
Creates an Array for the elements of the Query.
Creates an Array for the elements of the Query.
A callback that selects a value for each element.
Creates a Lookup
for the elements of the Query
.
A callback used to select a key for each element.
Creates a Lookup
for the elements of the Query
.
A callback used to select a key for each element.
A callback that selects a value for each element.
Creates a Map
for the elements of the Query
.
A callback used to select a key for each element.
Creates a Map
for the elements of the Query
.
A callback used to select a key for each element.
A callback that selects a value for each element.
Creates an object
for the elements of the Query
.
The prototype for the object.
A callback used to select a key for each element.
Creates an object
for the elements of the Query
.
The prototype for the object.
A callback used to select a key for each element.
A callback that selects a value for each element.
Unzips a sequence of tuples into a tuple of sequences.
Unzips a sequence of tuples into a tuple of sequences.
A callback that converts a result into a tuple.
Creates a subquery for the elements of this Query
with the provided value appended to the end.
The value to append.
Creates a subquery that concatenates this Query
with another Queryable.
Creates a subquery that contains the provided default value if this Query
contains no elements.
The default value.
Creates a subquery for the distinct elements of this Query
.
Creates a subquery for the distinct elements of this Query
.
A callback used to select the key to determine uniqueness.
Lazily invokes a callback as each element of the query is iterated.
The callback to invoke.
An element of the source.
The offset from the start of the source iterable.
Creates a subquery for the set difference between this and another Queryable.
Creates a subquery whose elements match the supplied predicate.
A callback used to match each element.
The element to test.
The offset from the start of the source iterable.
Creates a subquery whose elements match the supplied predicate.
A callback used to match each element.
The element to test.
The offset from the start of the source iterable.
Creates a subquery whose elements are neither null
nor undefined
.
Creates a subquery that iterates the results of applying a callback to each element.
A callback used to map each element into an iterable.
The element to flatMap.
Creates a subquery that iterates the results of applying a callback to each element.
A callback used to map each element into an iterable.
The element to flatMap.
Groups each element of this Query
by its key.
A callback used to select the key for an element.
Groups each element by its key.
A callback used to select the key for an element.
A callback used to select a value for an element.
Groups each element by its key.
A callback used to select the key for an element.
A callback used to select a value for an element.
A callback used to select a result from a group.
Creates a subquery for the set intersection of this Query
and another Queryable.
A Queryable object.
Creates a subquery for the set intersection of this Query
and another Queryable.
A Queryable object.
Creates a subquery for the set intersection of this Query
and another Queryable.
A Queryable object.
Creates a subquery for the set intersection of this Query
and another Queryable.
A Queryable object.
Creates a subquery for the set intersection of this Query
and another Queryable.
Creates a subquery for the set intersection of this Query
and another Queryable.
Creates a subquery by applying a callback to each element.
A callback used to map each element.
The element to map.
The offset from the start of the source iterable.
Creates a subquery for the elements of this Query
with the provided range
patched into the results.
The offset at which to patch the range.
The number of elements to skip from start.
The range to patch into the result.
Creates a subquery for the elements of this Query
with the provided value prepended to the beginning.
The value to prepend.
Creates a subquery for the set difference between this and another Queryable.
Creates a subquery whose elements are in the reverse order.
Creates a subquery containing the cumulative results of applying the provided callback to each element.
The callback used to compute each result.
Creates a subquery containing the cumulative results of applying the provided callback to each element.
The callback used to compute each result.
An optional seed value.
Creates a subquery containing the cumulative results of applying the provided callback to each element in reverse.
The callback used to compute each result.
Creates a subquery containing the cumulative results of applying the provided callback to each element in reverse.
The callback used to compute each result.
An optional seed value.
Creates a subquery by applying a callback to each element.
NOTE: This is an alias for map
.
A callback used to map each element.
The element to map.
The offset from the start of the source iterable.
Creates a subquery that iterates the results of applying a callback to each element.
NOTE: This is an alias for flatMap
.
A callback used to map each element into an iterable.
The element to flatMap.
Creates a subquery that iterates the results of applying a callback to each element.
NOTE: This is an alias for flatMap
.
A callback used to map each element into an iterable.
The element to flatMap.
Creates a subquery containing all elements except the first elements up to the supplied count.
The number of elements to skip.
Creates a subquery containing all elements except the last elements up to the supplied count.
The number of elements to skip.
Creates a subquery containing all elements except the first elements that don't match the supplied predicate.
A callback used to match each element.
Creates a subquery containing all elements except the first elements that match the supplied predicate.
A callback used to match each element.
Creates a subquery whose elements are the contiguous ranges of elements that share the same key.
A callback used to select the key for an element.
Creates a subquery whose values are computed from each element of the contiguous ranges of elements that share the same key.
A callback used to select the key for an element.
A callback used to select a value for an element.
Creates a subquery whose values are computed from the contiguous ranges of elements that share the same key.
A callback used to select the key for an element.
A callback used to select a value for an element.
A callback used to select a result from a contiguous range.
Creates a subquery for the symmetric difference between this and another Queryable.
Creates a subquery containing the first elements up to the supplied count.
The number of elements to take.
Creates a subquery containing the last elements up to the supplied count.
The number of elements to take.
Creates a subquery containing the first elements that do not match the supplied predicate.
A callback used to match each element.
Creates a subquery containing the first elements that match the supplied predicate.
A callback used to match each element.
Creates a subquery containing the first elements that match the supplied predicate.
A callback used to match each element.
Lazily invokes a callback as each element of the query is iterated.
NOTE: This is an alias for do
.
The callback to invoke.
An element of the source.
The offset from the start of the source iterable.
Pass the entire query to the provided callback, creating a new query from the result.
A callback function.
Creates a subquery for the set union of this Query
and another Queryable.
Creates a subquery whose elements match the supplied predicate.
NOTE: This is an alias for filter
.
A callback used to match each element.
The element to test.
The offset from the start of the source iterable.
Creates a subquery whose elements match the supplied predicate.
NOTE: This is an alias for filter
.
A callback used to match each element.
The element to test.
The offset from the start of the source iterable.
Creates a subquery whose elements are neither null
nor undefined
.
NOTE: This is an alias for filterDefined
.
Creates a subquery for the symmetric difference between this and another Queryable.
This is an alias for symmetricDifference
.
Creates an ordered subquery whose elements are sorted in ascending order by the provided key.
A callback used to select the key for an element.
An optional callback used to compare two keys.
Creates an ordered subquery whose elements are sorted in descending order by the provided key.
A callback used to select the key for an element.
An optional callback used to compare two keys.
Creates a subsequent ordered subquery whose elements are sorted in ascending order by the provided key.
A callback used to select the key for an element.
An optional callback used to compare two keys.
Creates a subsequent ordered subquery whose elements are sorted in descending order by the provided key.
A callback used to select the key for an element.
An optional callback used to compare two keys.
Creates a subquery for the correlated elements of this Query
and another Queryable.
A Queryable object.
A callback used to select the key for an element in this Query
.
A callback used to select the key for an element in the other Queryable.
A callback used to select the result for the correlated elements.
Creates a grouped subquery for the correlated elements of this Query
and another Queryable object.
A Queryable object.
A callback used to select the key for an element in this Query
.
A callback used to select the key for an element in the other Queryable object.
A callback used to select the result for the correlated elements.
Creates a subquery for the correlated elements of this Query
and another Queryable.
A Queryable object.
A callback used to select the key for an element in this Query
.
A callback used to select the key for an element in the other Queryable.
A callback used to select the result for the correlated elements.
Creates a subquery that combines this Query
with another Queryable by combining elements
in tuples.
Creates a subquery that combines this Query
with another Queryable by combining elements
using the supplied callback.
A Queryable object.
A callback used to combine two elements.
Creates a subquery for the ancestors of each element in the hierarchy.
A callback used to filter the results.
Creates a subquery for the ancestors of each element in the hierarchy.
A callback used to filter the results.
Creates a subquery for the ancestors of each element as well as each element in the hierarchy.
A callback used to filter the results.
Creates a subquery for the ancestors of each element as well as each element in the hierarchy.
A callback used to filter the results.
Creates a subquery for the bottom-most elements. Elements that are an ancestor of any other element are removed.
Creates a subquery for the bottom-most elements. Elements that are an ancestor of any other element are removed.
Creates a subquery for the children of each element in the hierarchy.
A callback used to filter the results.
Creates a subquery for the children of each element in the hierarchy.
A callback used to filter the results.
Creates a subquery for the descendants of each element in the hierarchy.
A callback used to filter the results.
Creates a subquery for the descendants of each element in the hierarchy.
A callback used to filter the results.
Creates a subquery for the descendants of each element as well as each element in the hierarchy.
A callback used to filter the results.
Creates a subquery for the descendants of each element as well as each element in the hierarchy.
A callback used to filter the results.
Creates a subquery for the child of each element at the specified offset. A negative offset starts from the last child.
The offset for the child.
Creates a subquery for the parents of each element in the hierarchy.
A callback used to filter the results.
Creates a subquery for the parents of each element in the hierarchy.
A callback used to filter the results.
Creates a subquery for the roots of each element in the hierarchy.
A callback used to filter the results.
Creates a subquery for the roots of each element in the hierarchy.
A callback used to filter the results.
Creates a subquery for this query
.
A callback used to filter the results.
Creates a subquery for this query
.
A callback used to filter the results.
Creates a subquery for this query
.
A callback used to filter the results.
Creates a subquery for the siblings of each element in the hierarchy.
A callback used to filter the results.
Creates a subquery for the siblings of each element in the hierarchy.
A callback used to filter the results.
Creates a subquery for the siblings after each element in the hierarchy.
A callback used to filter the results.
Creates a subquery for the siblings after each element in the hierarchy.
A callback used to filter the results.
Creates a subquery for the siblings of each element as well as each element in the hierarchy.
A callback used to filter the results.
Creates a subquery for the siblings of each element as well as each element in the hierarchy.
A callback used to filter the results.
Creates a subquery for the siblings before each element in the hierarchy.
A callback used to filter the results.
Creates a subquery for the siblings before each element in the hierarchy.
A callback used to filter the results.
Creates a HierarchyQuery using the provided HierarchyProvider.
A HierarchyProvider.
Creates a subquery for the top-most elements. Elements that are a descendant of any other element are removed.
Creates a subquery for the top-most elements. Elements that are a descendant of any other element are removed.
Generated using TypeDoc
Represents an ordered sequence of hierarchically organized values.