Soukai

Appearance

Class: DocumentsCache ​

Defined in: packages/soukai-solid/src/utils/DocumentsCache.ts:14

Constructors ​

Constructor ​

new DocumentsCache(name, engine): DocumentsCache

Defined in: packages/soukai-solid/src/utils/DocumentsCache.ts:20

Parameters ​

name ​

string

engine ​

Engine

Returns ​

DocumentsCache

Properties ​

active ​

protected active: Partial<Record<string, boolean>> = {}

Defined in: packages/soukai-solid/src/utils/DocumentsCache.ts:18

engine ​

protected engine: Engine

Defined in: packages/soukai-solid/src/utils/DocumentsCache.ts:16

metadata ​

protected metadata: IndexedDBMap<DocumentMetadata>

Defined in: packages/soukai-solid/src/utils/DocumentsCache.ts:17

Methods ​

activate() ​

activate(collection, id, modifiedAt): Promise<void>

Defined in: packages/soukai-solid/src/utils/DocumentsCache.ts:91

Parameters ​

collection ​

string

id ​

string

modifiedAt ​

number

Returns ​

Promise<void>

clear() ​

clear(): Promise<void>

Defined in: packages/soukai-solid/src/utils/DocumentsCache.ts:97

Returns ​

Promise<void>

forget() ​

forget(collection, id): Promise<void>

Defined in: packages/soukai-solid/src/utils/DocumentsCache.ts:87

Parameters ​

collection ​

string

id ​

string

Returns ​

Promise<void>

get() ​

get(collection, id): Promise<null | EngineDocument>

Defined in: packages/soukai-solid/src/utils/DocumentsCache.ts:29

Parameters ​

collection ​

string

id ​

string

Returns ​

Promise<null | EngineDocument>

getDocumentKey() ​

protected getDocumentKey(collection, id): string

Defined in: packages/soukai-solid/src/utils/DocumentsCache.ts:103

Parameters ​

collection ​

string

id ​

string

Returns ​

string

has() ​

has(collection, id): boolean

Defined in: packages/soukai-solid/src/utils/DocumentsCache.ts:25

Parameters ​

collection ​

string

id ​

string

Returns ​

boolean

remember() ​

remember(collection, id, modifiedAt, options): Promise<void>

Defined in: packages/soukai-solid/src/utils/DocumentsCache.ts:65

Parameters ​

collection ​

string

id ​

string

modifiedAt ​

number | Date

options ​
tombstone? ​

{ resourceUrl: string; url: string; }

tombstone.resourceUrl ​

string

tombstone.url ​

string

Returns ​

Promise<void>