Skip to main content
Version: 0.17

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

NameType
DataData
DetailsDetails
Oextends Operation
TransformBuilderTransformBuilder
Optionsextends RequestOptions = RequestOptions

Methods

_push

_push(transform, hints?): Promise<FullResponse<Data, Details, O>>

Parameters

NameType
transformTransform<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

NameType
RequestOperationextends Operation = O

Parameters

NameType
transformOrOperationsTransformOrOperations<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

NameType
RequestDataData
RequestDetailsDetails
RequestOperationextends Operation = O

Parameters

NameType
transformOrOperationsTransformOrOperations<O, TransformBuilder>
optionsFullRequestOptions<Options>
id?string

Returns

Promise<FullResponse<RequestData, RequestDetails, RequestOperation>>

Defined in

packages/@orbit/data/src/source-interfaces/pushable.ts:52