Skip to content

@oneplatform/app-sdk


@oneplatform/app-sdk / MutationResult

Interface: MutationResult\<T>

Defined in: types/entities.ts:72

Type Parameters

T

T

Properties

bulkCreate

bulkCreate: (items) => Promise\<BulkResult\<T>>

Defined in: types/entities.ts:79

Parameters

items

Partial\<T>[]

Returns

Promise\<BulkResult\<T>>


create

create: (data) => Promise\<T>

Defined in: types/entities.ts:73

Parameters

data

Partial\<T>

Returns

Promise\<T>


error

error: AppSDKError | null

Defined in: types/entities.ts:82


isError

isError: boolean

Defined in: types/entities.ts:81


isLoading

isLoading: boolean

Defined in: types/entities.ts:80


remove

remove: (id) => Promise\<void>

Defined in: types/entities.ts:78

Parameters

id

string

Returns

Promise\<void>


replace

replace: (id, data) => Promise\<T>

Defined in: types/entities.ts:77

PUT — full replacement

Parameters

id

string

data

T

Returns

Promise\<T>


reset

reset: () => void

Defined in: types/entities.ts:84

Clears isError and error state

Returns

void


update

update: (id, data) => Promise\<T>

Defined in: types/entities.ts:75

PATCH — partial update

Parameters

id

string

data

Partial\<T>

Returns

Promise\<T>