Skip to main content
server.ProjectedOrderedQuery A query whose output has been projected, with an order already defined. It is not a OrderedQuery: its documents are the projection, so assigning one to OrderedQuery<TableInfo> would claim properties that were never requested and are not evaluated.

Type parameters

Hierarchy

Methods

filter

▸ filter(predicate): ProjectedOrderedQuery<TableInfo, Fields> Filter the projected query’s output. The predicate still evaluates the original document, including properties the projection omits, so a filter means exactly what it means on an unprojected query.

Parameters

Returns

ProjectedOrderedQuery<TableInfo, Fields>

paginate

▸ paginate(paginationOpts): Promise<PaginationResult<SelectedDocument<DocumentByInfo<TableInfo>, Fields>>> Load a page of projected results.

Parameters

Returns

Promise<PaginationResult<SelectedDocument<DocumentByInfo<TableInfo>, Fields>>>

collect

▸ collect(): Promise<SelectedDocument<DocumentByInfo<TableInfo>, Fields>[]> Return all of the projected results as an array.

Returns

Promise<SelectedDocument<DocumentByInfo<TableInfo>, Fields>[]>

take

▸ take(n): Promise<SelectedDocument<DocumentByInfo<TableInfo>, Fields>[]> Return the first n projected results.

Parameters

Returns

Promise<SelectedDocument<DocumentByInfo<TableInfo>, Fields>[]>

first

▸ first(): Promise<null | SelectedDocument<DocumentByInfo<TableInfo>, Fields>> Return the first projected result, or null.

Returns

Promise<null | SelectedDocument<DocumentByInfo<TableInfo>, Fields>>

unique

▸ unique(): Promise<null | SelectedDocument<DocumentByInfo<TableInfo>, Fields>> Return the single projected result, or null; throw if there are more.

Returns

Promise<null | SelectedDocument<DocumentByInfo<TableInfo>, Fields>>

[asyncIterator]

▸ [asyncIterator](): AsyncIterator<SelectedDocument<DocumentByInfo<TableInfo>, Fields>, any, undefined>

Returns

AsyncIterator<SelectedDocument<DocumentByInfo<TableInfo>, Fields>, any, undefined>

Inherited from

AsyncIterable.[asyncIterator]