Soukai

Appearance

Class: SolidEngine ​

Defined in: packages/soukai-solid/src/engines/SolidEngine.ts:58

Implements ​

Constructors ​

Constructor ​

new SolidEngine(fetch?, config?): SolidEngine

Defined in: packages/soukai-solid/src/engines/SolidEngine.ts:68

Parameters ​

fetch? ​

Fetch

config? ​

Partial<SolidEngineConfig> = {}

Returns ​

SolidEngine

Properties ​

__isSolidEngine ​

__isSolidEngine: boolean = true

Defined in: packages/soukai-solid/src/engines/SolidEngine.ts:60

Accessors ​

listeners ​

Get Signature ​

get listeners(): Listeners<SolidEngineListener>

Defined in: packages/soukai-solid/src/engines/SolidEngine.ts:85

Returns ​

Listeners<SolidEngineListener>

Methods ​

addListener() ​

addListener(listener): () => void

Defined in: packages/soukai-solid/src/engines/SolidEngine.ts:186

Parameters ​

listener ​

SolidEngineListener

Returns ​

Function

Returns ​

void

Deprecated ​

Use .listeners instead.

clearCache() ​

clearCache(): void

Defined in: packages/soukai-solid/src/engines/SolidEngine.ts:197

Returns ​

void

create() ​

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

Defined in: packages/soukai-solid/src/engines/SolidEngine.ts:97

Parameters ​

collection ​

string

document ​

EngineDocument

id? ​

string

Returns ​

Promise<string>

Implementation of ​

Engine.create

delete() ​

delete(collection, id): Promise<void>

Defined in: packages/soukai-solid/src/engines/SolidEngine.ts:175

Parameters ​

collection ​

string

id ​

string

Returns ​

Promise<void>

Implementation of ​

Engine.delete

getFetch() ​

getFetch(): Fetch

Defined in: packages/soukai-solid/src/engines/SolidEngine.ts:93

Returns ​

Fetch

readMany() ​

readMany(collection, filters): Promise<EngineDocumentsCollection>

Defined in: packages/soukai-solid/src/engines/SolidEngine.ts:137

Parameters ​

collection ​

string

filters ​

EngineFilters = {}

Returns ​

Promise<EngineDocumentsCollection>

Implementation of ​

Engine.readMany

readOne() ​

readOne(_, id): Promise<EngineDocument>

Defined in: packages/soukai-solid/src/engines/SolidEngine.ts:122

Parameters ​

_ ​

string

id ​

string

Returns ​

Promise<EngineDocument>

Implementation of ​

Engine.readOne

removeListener() ​

removeListener(listener): void

Defined in: packages/soukai-solid/src/engines/SolidEngine.ts:193

Parameters ​

listener ​

SolidEngineListener

Returns ​

void

Deprecated ​

Use .listeners instead.

setConfig() ​

setConfig(config): void

Defined in: packages/soukai-solid/src/engines/SolidEngine.ts:89

Parameters ​

config ​

Partial<SolidEngineConfig>

Returns ​

void

update() ​

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

Defined in: packages/soukai-solid/src/engines/SolidEngine.ts:153

Parameters ​

collection ​

string

id ​

string

updates ​

EngineUpdates

Returns ​

Promise<void>

Implementation of ​

Engine.update