Skip to main content
Version: 0.17

Interface: Queryable<Data, Details, O, QE, QueryBuilder, Options>

A source decorated as @queryable must also implement the Queryable interface.

Type parameters

NameType
DataData
DetailsDetails
Oextends Operation
QEextends QueryExpression
QueryBuilderQueryBuilder
Optionsextends RequestOptions = RequestOptions

Hierarchy

  • AsyncQueryable<Data, Details, O, QE, QueryBuilder, Options>

    Queryable

Methods

_query

_query(query, hints?): Promise<FullResponse<Data, Details, O>>

Parameters

NameType
queryQuery<QE>
hints?ResponseHints<Data, Details>

Returns

Promise<FullResponse<Data, Details, O>>

Defined in

packages/@orbit/data/src/source-interfaces/queryable.ts:38


query

query<RequestData>(queryOrExpressions, options?, id?): Promise<RequestData>

Type parameters

NameType
RequestDataData

Parameters

NameType
queryOrExpressionsQueryOrExpressions<QE, QueryBuilder>
options?DefaultRequestOptions<Options>
id?string

Returns

Promise<RequestData>

Inherited from

AsyncQueryable.query

Defined in

packages/@orbit/data/src/queryable.ts:19

query<RequestData, RequestDetails, RequestOperation>(queryOrExpressions, options, id?): Promise<FullResponse<RequestData, RequestDetails, RequestOperation>>

Type parameters

NameType
RequestDataData
RequestDetailsDetails
RequestOperationextends Operation = O

Parameters

NameType
queryOrExpressionsQueryOrExpressions<QE, QueryBuilder>
optionsFullRequestOptions<Options>
id?string

Returns

Promise<FullResponse<RequestData, RequestDetails, RequestOperation>>

Inherited from

AsyncQueryable.query

Defined in

packages/@orbit/data/src/queryable.ts:24