"iterable-query" | iterable-query

Index

Classes

Interfaces

Type aliases

Functions

Type aliases

AsyncChoice

AsyncChoice: [PromiseLike<K> | K, AsyncQueryable<V>]

AsyncHierarchyQueryFlow

AsyncHierarchyQueryFlow: AsyncHierarchyQueryFlow<S, T>

Flows the base type of a Query as a hierarchical query with a new iterated type.

AsyncOrderedQueryFlow

AsyncOrderedQueryFlow: AsyncOrderedQueryFlow<S, T>

Flows the base type of a Query as an ordered query with a new iterated type.

AsyncQueryFlow

AsyncQueryFlow: AsyncQueryFlow<S, T>

Flows the base type of a Query with a new iterated type.

AsyncQueryable

AsyncQueryable: AsyncIterable<T> | Queryable<PromiseLike<T> | T>

AsyncUnorderedQueryFlow

AsyncUnorderedQueryFlow: AsyncUnorderedQueryFlow<S, T>

Flows the base type of a Query as an unordered query with a new iterated type.

Choice

Choice: [K, Queryable<V>]

HierarchyQueryFlow

HierarchyQueryFlow: HierarchyQueryFlow<S, T>

Flows the base type of a Query as a hierarchical query with a new iterated type.

KeyValuePair

KeyValuePair: KeyValuePair<T, K>

Typed key-value pairs derived from the properties of an object.

OrderedQueryFlow

OrderedQueryFlow: OrderedQueryFlow<S, T>

Flows the base type of a Query as an ordered query with a new iterated type.

PossiblyAsyncHierarchyIterable

PossiblyAsyncHierarchyIterable: AsyncHierarchyIterable<TNode, T> | HierarchyIterable<TNode, T>

PossiblyAsyncIterable

PossiblyAsyncIterable: AsyncIterable<T> | Iterable<PromiseLike<T> | T>

PossiblyAsyncOrderedHierarchyIterable

PossiblyAsyncOrderedHierarchyIterable: AsyncOrderedHierarchyIterable<TNode, T> | OrderedHierarchyIterable<TNode, T>

PossiblyAsyncOrderedIterable

PossiblyAsyncOrderedIterable: AsyncOrderedIterable<T> | OrderedIterable<T>

QueriedType

QueriedType: QueriedType<T>

QueryFlow

QueryFlow: QueryFlow<S, T>

Flows the base type of a Query with a new iterated type.

Queryable

Queryable: Iterable<T> | ArrayLike<T>

UnorderedQueryFlow

UnorderedQueryFlow: UnorderedQueryFlow<S, T>

Flows the base type of a Query as an unordered query with a new iterated type.

Functions

from

from<TNode, T>(source: OrderedHierarchyIterable<TNode, T>): OrderedHierarchyQuery<TNode, T>
from<TNode, T>(source: HierarchyIterable<TNode, T>): HierarchyQuery<TNode, T>
from<T>(source: OrderedIterable<T>): OrderedQuery<T>
from<T>(source: Queryable<T>): Query<T>
from<TNode, T>(source: OrderedIterable<T>, hierarchy: HierarchyProvider<TNode>): OrderedHierarchyQuery<TNode, T>
from<TNode, T>(source: Queryable<T>, hierarchy: HierarchyProvider<TNode>): HierarchyQuery<TNode, T>

- Defined in query.ts:60
Creates a Query from a Queryable source.

Type parameters
- TNode
- T: TNode
Parameters
- source: OrderedHierarchyIterable<TNode, T> —
  
  An OrderedHierarchyIterable object.
Returns OrderedHierarchyQuery<TNode, T>
- Defined in query.ts:66
Creates a Query from a Queryable source.

Type parameters
- TNode
- T: TNode
Parameters
- source: HierarchyIterable<TNode, T> —
  
  An OrderedHierarchyIterable object.
Returns HierarchyQuery<TNode, T>
- Defined in query.ts:72
Creates a Query from a Queryable source.

Type parameters
- T
Parameters
- source: OrderedIterable<T> —
  
  An OrderedHierarchyIterable object.
Returns OrderedQuery<T>
- Defined in query.ts:78
Creates a Query from a Queryable source.

Type parameters
- T
Parameters
- source: Queryable<T> —
  
  An OrderedHierarchyIterable object.
Returns Query<T>
- Defined in query.ts:85
Creates a Query from a Queryable source.

Type parameters
- TNode
- T: TNode
Parameters
- source: OrderedIterable<T> —
  
  An OrderedHierarchyIterable object.
- hierarchy: HierarchyProvider<TNode> —
  
  A HierarchyProvider object.
Returns OrderedHierarchyQuery<TNode, T>
- Defined in query.ts:92
Creates a Query from a Queryable source.

Type parameters
- TNode
- T: TNode
Parameters
- source: Queryable<T> —
  
  An OrderedHierarchyIterable object.
- hierarchy: HierarchyProvider<TNode> —
  
  A HierarchyProvider object.
Returns HierarchyQuery<TNode, T>

fromAsync

fromAsync<TNode, T>(source: PossiblyAsyncOrderedHierarchyIterable<TNode, T>): AsyncOrderedHierarchyQuery<TNode, T>
fromAsync<TNode, T>(source: PossiblyAsyncHierarchyIterable<TNode, T>): AsyncHierarchyQuery<TNode, T>
fromAsync<T>(source: PossiblyAsyncOrderedIterable<T>): AsyncOrderedQuery<T>
fromAsync<T>(source: AsyncQueryable<T>): AsyncQuery<T>
fromAsync<TNode, T>(source: PossiblyAsyncOrderedIterable<T>, hierarchy: HierarchyProvider<TNode>): AsyncOrderedHierarchyQuery<TNode, T>
fromAsync<TNode, T>(source: AsyncQueryable<T>, hierarchy: HierarchyProvider<TNode>): AsyncHierarchyQuery<TNode, T>

- Defined in asyncQuery.ts:61
Creates an AsyncQuery from an AsyncQueryable source.

Type parameters
- TNode
- T: TNode
Parameters
- source: PossiblyAsyncOrderedHierarchyIterable<TNode, T> —
  
  An AsyncQueryable object.
Returns AsyncOrderedHierarchyQuery<TNode, T>
- Defined in asyncQuery.ts:68
Creates an AsyncQuery from an AsyncQueryable source.

Type parameters
- TNode
- T: TNode
Parameters
- source: PossiblyAsyncHierarchyIterable<TNode, T> —
  
  An AsyncQueryable object.
Returns AsyncHierarchyQuery<TNode, T>
- Defined in asyncQuery.ts:75
Creates an AsyncQuery from an AsyncQueryable source.

Type parameters
- T
Parameters
- source: PossiblyAsyncOrderedIterable<T> —
  
  An AsyncQueryable object.
Returns AsyncOrderedQuery<T>
- Defined in asyncQuery.ts:82
Creates an AsyncQuery from an AsyncQueryable source.

Type parameters
- T
Parameters
- source: AsyncQueryable<T> —
  
  An AsyncQueryable object.
Returns AsyncQuery<T>
- Defined in asyncQuery.ts:90
Creates an AsyncHierarchyQuery from an AsyncQueryable source.

Type parameters
- TNode
- T: TNode
Parameters
- source: PossiblyAsyncOrderedIterable<T> —
  
  An AsyncQueryable object.
- hierarchy: HierarchyProvider<TNode> —
  
  A HierarchyProvider object.
Returns AsyncOrderedHierarchyQuery<TNode, T>
- Defined in asyncQuery.ts:98
Creates an AsyncHierarchyQuery from an AsyncQueryable source.

Type parameters
- TNode
- T: TNode
Parameters
- source: AsyncQueryable<T> —
  
  An AsyncQueryable object.
- hierarchy: HierarchyProvider<TNode> —
  
  A HierarchyProvider object.
Returns AsyncHierarchyQuery<TNode, T>

Index

Classes

Interfaces

Type aliases

Functions

Type aliases

AsyncChoice

AsyncHierarchyQueryFlow

AsyncOrderedQueryFlow

AsyncQueryFlow

AsyncQueryable

AsyncUnorderedQueryFlow

Choice

HierarchyQueryFlow

KeyValuePair

OrderedQueryFlow

PossiblyAsyncHierarchyIterable

PossiblyAsyncIterable

PossiblyAsyncOrderedHierarchyIterable

PossiblyAsyncOrderedIterable

QueriedType

QueryFlow

Queryable

UnorderedQueryFlow

Functions

from

Type parameters

Parameters

Returns OrderedHierarchyQuery<TNode, T>

Type parameters

Parameters

Returns HierarchyQuery<TNode, T>

Type parameters

Parameters

Returns OrderedQuery<T>

Type parameters

Parameters

Returns Query<T>

Type parameters

Parameters

Returns OrderedHierarchyQuery<TNode, T>

Type parameters

Parameters

Returns HierarchyQuery<TNode, T>

fromAsync

Type parameters

Parameters

Returns AsyncOrderedHierarchyQuery<TNode, T>

Type parameters

Parameters

Returns AsyncHierarchyQuery<TNode, T>

Type parameters

Parameters

Returns AsyncOrderedQuery<T>

Type parameters

Parameters

Returns AsyncQuery<T>

Type parameters

Parameters

Returns AsyncOrderedHierarchyQuery<TNode, T>

Type parameters

Parameters

Returns AsyncHierarchyQuery<TNode, T>