Soukai

Appearance

Interface: Engine ​

Defined in: packages/soukai/src/engines/Engine.ts:53

Methods ​

create() ​

create(collection, document, id?): Promise<string>

Defined in: packages/soukai/src/engines/Engine.ts:54

Parameters ​

collection ​

string

document ​

EngineDocument

id? ​

string

Returns ​

Promise<string>

delete() ​

delete(collection, id): Promise<void>

Defined in: packages/soukai/src/engines/Engine.ts:62

Parameters ​

collection ​

string

id ​

string

Returns ​

Promise<void>

readMany() ​

readMany(collection, filters?): Promise<EngineDocumentsCollection>

Defined in: packages/soukai/src/engines/Engine.ts:58

Parameters ​

collection ​

string

filters? ​

EngineFilters

Returns ​

Promise<EngineDocumentsCollection>

readOne() ​

readOne(collection, id): Promise<EngineDocument>

Defined in: packages/soukai/src/engines/Engine.ts:56

Parameters ​

collection ​

string

id ​

string

Returns ​

Promise<EngineDocument>

update() ​

update(collection, id, updates): Promise<void>

Defined in: packages/soukai/src/engines/Engine.ts:60

Parameters ​

collection ​

string

id ​

string

updates ​

EngineUpdates

Returns ​

Promise<void>