Class: BaseStorage<Schemas>

Defined in: ridb_core.d.ts:350

Extends

• StorageInternal<Schemas>

Extended by

• InMemory
• IndexDB

Type Parameters

Schemas

Schemas extends SchemaTypeRecord

Constructors

Constructor

new BaseStorage<Schemas>(dbName, schemas, options?): BaseStorage<Schemas>

Defined in: ridb_core.d.ts:360

Parameters

dbName

string

schemas

Schemas

options?

BaseStorageOptions

Returns

BaseStorage<Schemas>

Overrides

StorageInternal.constructor

Properties

core

readonly core: CoreStorage

Defined in: ridb_core.d.ts:368

dbName

readonly dbName: string

Defined in: ridb_core.d.ts:365

options

readonly options: BaseStorageOptions

Defined in: ridb_core.d.ts:367

schemas

readonly schemas: Record<keyof Schemas, Schema<Schemas[keyof Schemas]>>

Defined in: ridb_core.d.ts:366

Methods

addIndexSchemas()

addIndexSchemas(): null

Defined in: ridb_core.d.ts:378

Returns

null

close()

close(): Promise<void>

Defined in: ridb_core.d.ts:370

Returns

Promise<void>

Overrides

StorageInternal.close

count()

count(colectionName, query, options?): Promise<number>

Defined in: ridb_core.d.ts:371

Parameters

colectionName

keyof Schemas

query

QueryType<Schemas[keyof Schemas]>

options?

QueryOptions

Returns

Promise<number>

Overrides

StorageInternal.count

find()

find(collectionName, query, options?): Promise<Doc<Schemas[keyof Schemas]>[]>

Defined in: ridb_core.d.ts:373

Parameters

collectionName

keyof Schemas

query

QueryType<Schemas[keyof Schemas]>

options?

QueryOptions

Returns

Promise<Doc<Schemas[keyof Schemas]>[]>

Overrides

StorageInternal.find

findDocumentById()

findDocumentById(collectionName, id): Promise<null | Doc<Schemas[keyof Schemas]>>

Defined in: ridb_core.d.ts:372

Parameters

collectionName

keyof Schemas

id

string

Returns

Promise<null | Doc<Schemas[keyof Schemas]>>

Overrides

StorageInternal.findDocumentById

getOption()

getOption(name): undefined | string | number | boolean

Defined in: ridb_core.d.ts:375

Parameters

name

string

Returns

undefined | string | number | boolean

getSchema()

getSchema(name): Schema<any>

Defined in: ridb_core.d.ts:376

Parameters

name

string

Returns

Schema<any>

start()

start(): Promise<void>

Defined in: ridb_core.d.ts:369

Returns

Promise<void>

Overrides

StorageInternal.start

write()

write(op): Promise<Doc<Schemas[keyof Schemas]>>

Defined in: ridb_core.d.ts:374

Parameters

op

Operation<Schemas[keyof Schemas]>

Returns

Promise<Doc<Schemas[keyof Schemas]>>

Overrides

StorageInternal.write

create()

static create<SchemasCreate>(dbName, schemas, options?): Promise<BaseStorage<SchemasCreate>>

Defined in: ridb_core.d.ts:351

Type Parameters

SchemasCreate

SchemasCreate extends SchemaTypeRecord

Parameters

dbName

string

schemas

SchemasCreate

options?

BaseStorageOptions

Returns

Promise<BaseStorage<SchemasCreate>>