Interface: Pushable<Data, Details, O, TransformBuilder, Options>
A source decorated as @pushable must also implement the Pushable
interface.
deprecated since v0.17, use Updatable instead
Type parameters​
| Name | Type |
|---|---|
Data | Data |
Details | Details |
O | extends Operation |
TransformBuilder | TransformBuilder |
Options | extends RequestOptions = RequestOptions |
Methods​
_push​
â–¸ _push(transform, hints?): Promise<FullResponse<Data, Details, O>>
Parameters​
| Name | Type |
|---|---|
transform | Transform<O> |
hints? | ResponseHints<Data, Details> |
Returns​
Promise<FullResponse<Data, Details, O>>
Defined in​
packages/@orbit/data/src/source-interfaces/pushable.ts:62
push​
â–¸ push<RequestOperation>(transformOrOperations, options?, id?): Promise<Transform<RequestOperation>[]>
The push method accepts a Transform instance as an argument and returns
a promise that resolves to an array of Transform instances that are
applied as a result. In other words, push captures the direct results
and side effects of applying a Transform to a source.
Type parameters​
| Name | Type |
|---|---|
RequestOperation | extends Operation = O |
Parameters​
| Name | Type |
|---|---|
transformOrOperations | TransformOrOperations<O, TransformBuilder> |
options? | DefaultRequestOptions<Options> |
id? | string |
Returns​
Promise<Transform<RequestOperation>[]>
Defined in​
packages/@orbit/data/src/source-interfaces/pushable.ts:47
â–¸ push<RequestData, RequestDetails, RequestOperation>(transformOrOperations, options, id?): Promise<FullResponse<RequestData, RequestDetails, RequestOperation>>
Type parameters​
| Name | Type |
|---|---|
RequestData | Data |
RequestDetails | Details |
RequestOperation | extends Operation = O |
Parameters​
| Name | Type |
|---|---|
transformOrOperations | TransformOrOperations<O, TransformBuilder> |
options | FullRequestOptions<Options> |
id? | string |
Returns​
Promise<FullResponse<RequestData, RequestDetails, RequestOperation>>