Skip to main content
Version: 0.17

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

A source decorated as @pullable must also implement the Pullable interface.

deprecated since v0.17, use Queryable instead

Type parameters

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

Methods

_pull

_pull(query): Promise<FullResponse<Data, Details, O>>

Parameters

NameType
queryQuery<QE>

Returns

Promise<FullResponse<Data, Details, O>>

Defined in

packages/@orbit/data/src/source-interfaces/pullable.ts:65


pull

pull<RequestOperation>(queryOrExpressions, options?, id?): Promise<Transform<RequestOperation>[]>

The pull method accepts a query or expression(s) and returns a promise that resolves to an array of Transform instances that represent the changeset that resulted from applying the query. In other words, a pull request retrieves the results of a query in Transform form.

Type parameters

NameType
RequestOperationextends Operation = O

Parameters

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

Returns

Promise<Transform<RequestOperation>[]>

Defined in

packages/@orbit/data/src/source-interfaces/pullable.ts:50

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

Type parameters

NameType
RequestDataData
RequestDetailsDetails
RequestOperationextends Operation = O

Parameters

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

Returns

Promise<FullResponse<RequestData, RequestDetails, RequestOperation>>

Defined in

packages/@orbit/data/src/source-interfaces/pullable.ts:55