StoreInterface

@webda/core

---

Interface: StoreInterface<T>

Defined in: packages/core/src/stores/store.ts:191

Internal

A Store is low-level storage service

It does not handle any business logic, only CRUD operations

— Store-internal contract. App code uses Repository<T> from @webda/models.

Type Parameters

T

T = any

Methods

create()

create(uuid, object): Promise<any>

Defined in: packages/core/src/stores/store.ts:192

Parameters

uuid

PrimaryKey<any>

object

any

Returns

Promise<any>

---

delete()

delete(uuid): Promise<void>

Defined in: packages/core/src/stores/store.ts:195

Parameters

uuid

PrimaryKey<any>

Returns

Promise<void>

---

deleteItemFromCollection()

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

Defined in: packages/core/src/stores/store.ts:207

Parameters

uuid

PrimaryKey<any>

collection

string

index

number

itemWriteConditionField?

string

itemWriteCondition?

any

Returns

Promise<void>

---

exists()

exists(uuid): Promise<boolean>

Defined in: packages/core/src/stores/store.ts:196

Parameters

uuid

PrimaryKey<any>

Returns

Promise<boolean>

---

find()

find(query): Promise<StoreFindResult<any>>

Defined in: packages/core/src/stores/store.ts:214

Parameters

query

WebdaQLString<T>

Returns

Promise<StoreFindResult<any>>

---

get()

get(uuid): Promise<any>

Defined in: packages/core/src/stores/store.ts:193

Parameters

uuid

PrimaryKey<any>

Returns

Promise<any>

---

incrementAttributes()

incrementAttributes(uuid, info): Promise<Date>

Defined in: packages/core/src/stores/store.ts:217

Parameters

uuid

PrimaryKey<any>

info

object[]

Returns

Promise<Date>

---

iterate()

iterate(query): AsyncGenerator

Defined in: packages/core/src/stores/store.ts:216

Parameters

query

WebdaQLString<T>

Returns

AsyncGenerator

---

query()

query(query): Promise<StoreFindResult<any>>

Defined in: packages/core/src/stores/store.ts:215

Parameters

query

WebdaQLString<T>

Returns

Promise<StoreFindResult<any>>

---

removeAttribute()

removeAttribute(uuid, attribute): Promise<void>

Defined in: packages/core/src/stores/store.ts:198

Parameters

uuid

PrimaryKey<any>

attribute

string

Returns

Promise<void>

---

setAttribute()

setAttribute(uuid, attribute, value): Promise<void>

Defined in: packages/core/src/stores/store.ts:197

Parameters

uuid

PrimaryKey<any>

attribute

string

value

any

Returns

Promise<void>

---

update()

update(uuid, object): Promise<any>

Defined in: packages/core/src/stores/store.ts:194

Parameters

uuid

PrimaryKey<any>

object

any

Returns

Promise<any>

---

upsertItemToCollection()

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

Defined in: packages/core/src/stores/store.ts:199

Parameters

uuid

PrimaryKey<any>

collection

string

item

any

index?

number

itemWriteConditionField?

string

itemWriteCondition?

any

Returns

Promise<void>