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​
| Name | Type |
|---|---|
Data | Data |
Details | Details |
O | extends Operation |
QE | extends QueryExpression |
QueryBuilder | QueryBuilder |
Options | extends RequestOptions = RequestOptions |
Methods​
_pull​
â–¸ _pull(query): Promise<FullResponse<Data, Details, O>>
Parameters​
| Name | Type |
|---|---|
query | Query<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​
| Name | Type |
|---|---|
RequestOperation | extends Operation = O |
Parameters​
| Name | Type |
|---|---|
queryOrExpressions | QueryOrExpressions<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​
| 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>>