Skip to main content
Version: 0.17

Interface: Updatable<Data, Details, O, TransformBuilder, Options>

A source decorated as @updatable must also implement the Updatable interface.

Type parameters

NameType
DataData
DetailsDetails
Oextends Operation
TransformBuilderTransformBuilder
Optionsextends RequestOptions = RequestOptions

Hierarchy

  • AsyncUpdatable<Data, Details, O, TransformBuilder, Options>

    Updatable

Methods

_update

_update(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/updatable.ts:36


update

update<RequestData>(transformOrOperations, options?, id?): Promise<RequestData>

Type parameters

NameType
RequestDataData

Parameters

NameType
transformOrOperationsTransformOrOperations<O, TransformBuilder>
options?DefaultRequestOptions<Options>
id?string

Returns

Promise<RequestData>

Inherited from

AsyncUpdatable.update

Defined in

packages/@orbit/data/src/updatable.ts:17

update<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>>

Inherited from

AsyncUpdatable.update

Defined in

packages/@orbit/data/src/updatable.ts:22