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

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

Type parameters

Name	Type
Data	Data
Details	Details
O	extends Operation
QE	extends QueryExpression
QueryBuilder	QueryBuilder
Options	extends RequestOptions = RequestOptions

Hierarchy

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

  ↳ Queryable

Methods

_query

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

Parameters

Name	Type
query	Query<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

Name	Type
RequestData	Data

Parameters

Name	Type
queryOrExpressions	QueryOrExpressions<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

Name	Type
RequestData	Data
RequestDetails	Details
RequestOperation	extends Operation = O

Parameters

Name	Type
queryOrExpressions	QueryOrExpressions<QE, QueryBuilder>
options	FullRequestOptions<Options>
id?	string

Returns

Promise<FullResponse<RequestData, RequestDetails, RequestOperation>>

Inherited from

AsyncQueryable.query

Defined in

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