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

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

Type parameters

Name	Type
Data	Data
Details	Details
O	extends Operation
TransformBuilder	TransformBuilder
Options	extends RequestOptions = RequestOptions

Hierarchy

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

  ↳ Updatable

Methods

_update

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

---

update

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

Type parameters

Name	Type
RequestData	Data

Parameters

Name	Type
transformOrOperations	TransformOrOperations<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

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

Inherited from

AsyncUpdatable.update

Defined in

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