Soukai

Appearance

Class: ProxyEngine<SubjectEngine> ​

Defined in: packages/soukai/src/engines/ProxyEngine.ts:20

Deprecated ​

Use ProxyEngine class instead.

Extended by ​

Type Parameters ​

SubjectEngine ​

SubjectEngine extends Engine = Engine

Implements ​

Constructors ​

Constructor ​

new ProxyEngine<SubjectEngine>(subject, overrides?): ProxyEngine<SubjectEngine>

Defined in: packages/soukai/src/engines/ProxyEngine.ts:24

Parameters ​

subject ​

SubjectEngine

overrides? ​

Partial<Engine> = {}

Returns ​

ProxyEngine<SubjectEngine>

Properties ​

subject ​

readonly subject: SubjectEngine

Defined in: packages/soukai/src/engines/ProxyEngine.ts:21

Methods ​

create() ​

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

Defined in: packages/soukai/src/engines/ProxyEngine.ts:40

Parameters ​

collection ​

string

document ​

EngineDocument

id? ​

string

Returns ​

Promise<string>

Implementation of ​

Engine.create

delete() ​

delete(collection, id): Promise<void>

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

Parameters ​

collection ​

string

id ​

string

Returns ​

Promise<void>

Implementation of ​

Engine.delete

getProxySubject() ​

getProxySubject(): Engine

Defined in: packages/soukai/src/engines/ProxyEngine.ts:36

Returns ​

Engine

Implementation of ​

IProxyEngine.getProxySubject

readMany() ​

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

Defined in: packages/soukai/src/engines/ProxyEngine.ts:48

Parameters ​

collection ​

string

filters? ​

EngineFilters

Returns ​

Promise<EngineDocumentsCollection>

Implementation of ​

Engine.readMany

readOne() ​

readOne(collection, id): Promise<EngineDocument>

Defined in: packages/soukai/src/engines/ProxyEngine.ts:44

Parameters ​

collection ​

string

id ​

string

Returns ​

Promise<EngineDocument>

Implementation of ​

Engine.readOne

update() ​

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

Defined in: packages/soukai/src/engines/ProxyEngine.ts:52

Parameters ​

collection ​

string

id ​

string

updates ​

EngineUpdates

Returns ​

Promise<void>

Implementation of ​

Engine.update