StoreHelper

@webda/core

---

Interface: StoreHelper<T>

Defined in: packages/core/src/stores/istore.ts:7

This represent the injected methods of Store into the Model

Type Parameters

T

T extends object = object

Methods

create()

create(uuid, data): Promise<T>

Defined in: packages/core/src/stores/istore.ts:20

Create data in the store

Parameters

uuid

string

data

T

Returns

Promise<T>

---

delete()

delete<K>(uuid, conditionField?, condition?): Promise<void>

Defined in: packages/core/src/stores/istore.ts:46

Delete data from the store

Type Parameters

K

K extends string | number | symbol

Parameters

uuid

string

conditionField?

K

condition?

T[K]

Returns

Promise<void>

---

deleteItemFromCollection()

deleteItemFromCollection<K>(uuid, collection, index, itemWriteConditionField?, itemWriteCondition?): Promise<void>

Defined in: packages/core/src/stores/istore.ts:92

Delete item from a collection

Type Parameters

K

K extends string | number | symbol

Parameters

uuid

string

collection

K

index

number

itemWriteConditionField?

any

itemWriteCondition?

any

Returns

Promise<void>

---

exists()

exists(uuid): Promise<boolean>

Defined in: packages/core/src/stores/istore.ts:52

Verify if the object exists

Parameters

uuid

string

Returns

Promise<boolean>

---

get()

get(uuid): Promise<T>

Defined in: packages/core/src/stores/istore.ts:13

Get data from the store

Parameters

uuid

string

Returns

Promise<T>

---

incrementAttributes()

incrementAttributes<K, L>(uuid, info, conditionField?, condition?): Promise<void>

Defined in: packages/core/src/stores/istore.ts:59

Increment attributes of an object

Type Parameters

K

K extends string | number | symbol

L

L extends string | number | symbol

Parameters

uuid

string

info

(L | { property: L; value?: number; })[]

conditionField?

K

condition?

T[K]

Returns

Promise<void>

---

patch()

patch<K>(uuid, data, conditionField?, condition?): Promise<void>

Defined in: packages/core/src/stores/istore.ts:34

Patch data in the store, patching the object

Type Parameters

K

K extends string | number | symbol

Parameters

uuid

string

data

Partial<T>

conditionField?

K

condition?

T[K]

Returns

Promise<void>

---

query()

query(query): Promise<T[]>

Defined in: packages/core/src/stores/istore.ts:40

Query the store

Parameters

query

WebdaQLString<T>

Returns

Promise<T[]>

---

removeAttribute()

removeAttribute<L, K>(uuid, attribute, conditionField?, condition?): Promise<void>

Defined in: packages/core/src/stores/istore.ts:105

Remove an attribute from an object

Type Parameters

L

L extends string | number | symbol

K

K extends string | number | symbol

Parameters

uuid

string

attribute

K

conditionField?

L

condition?

T[L]

Returns

Promise<void>

---

update()

update<K>(uuid, data, conditionField?, condition?): Promise<void>

Defined in: packages/core/src/stores/istore.ts:27

Update data in the store, replacing the object

Type Parameters

K

K extends string | number | symbol

Parameters

uuid

string

data

T

conditionField?

K

condition?

T[K]

Returns

Promise<void>

---

upsertItemToCollection()

upsertItemToCollection<K>(uuid, collection, item, index?, itemWriteConditionField?, itemWriteCondition?): Promise<void>

Defined in: packages/core/src/stores/istore.ts:75

Upsert an item to a collection

Type Parameters

K

K extends string | number | symbol

Parameters

uuid

string

collection

K

item

any

index?

number

itemWriteConditionField?

any

itemWriteCondition?

any

Returns

Promise<void>