Class: BaseStorage<Schemas>

Defined in: ridb_core.d.ts:240

Extends

Extended by

Type Parameters

Schemas

Schemas extends SchemaTypeRecord

Constructors

Constructor

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

Defined in: ridb_core.d.ts:250

Parameters

dbName

string

schemas

Schemas

options?

BaseStorageOptions

Returns

BaseStorage<Schemas>

Overrides

StorageInternal.constructor

Properties

core

typescript
1
readonly core: CoreStorage

Defined in: ridb_core.d.ts:258

dbName

typescript
1
readonly dbName: string

Defined in: ridb_core.d.ts:255

options

typescript
1
readonly options: BaseStorageOptions

Defined in: ridb_core.d.ts:257

schemas

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

Defined in: ridb_core.d.ts:256

Methods

addIndexSchemas()

typescript
1
addIndexSchemas(): null

Defined in: ridb_core.d.ts:268

Returns

null

close()

typescript
1
close(): Promise<void>

Defined in: ridb_core.d.ts:260

Returns

Promise<void>

Overrides

StorageInternal.close

count()

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

Defined in: ridb_core.d.ts:261

Parameters

colectionName

keyof Schemas

query

QueryType<Schemas[keyof Schemas]>

options?

QueryOptions

Returns

Promise<number>

Overrides

StorageInternal.count

find()

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

Defined in: ridb_core.d.ts:263

Parameters

collectionName

keyof Schemas

query

QueryType<Schemas[keyof Schemas]>

options?

QueryOptions

Returns

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

Overrides

StorageInternal.find

findDocumentById()

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

Defined in: ridb_core.d.ts:262

Parameters

collectionName

keyof Schemas

id

string

Returns

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

Overrides

StorageInternal.findDocumentById

getOption()

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

Defined in: ridb_core.d.ts:265

Parameters

name

string

Returns

undefined | string | number | boolean

getSchema()

typescript
1
getSchema(name): Schema<any>

Defined in: ridb_core.d.ts:266

Parameters

name

string

Returns

Schema<any>

start()

typescript
1
start(): Promise<void>

Defined in: ridb_core.d.ts:259

Returns

Promise<void>

Overrides

StorageInternal.start

write()

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

Defined in: ridb_core.d.ts:264

Parameters

op

Operation<Schemas[keyof Schemas]>

Returns

Promise<Doc<Schemas[keyof Schemas]>>

Overrides

StorageInternal.write

create()

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

Defined in: ridb_core.d.ts:241

Type Parameters

SchemasCreate

SchemasCreate extends SchemaTypeRecord

Parameters

dbName

string

schemas

SchemasCreate

options?

BaseStorageOptions

Returns

Promise<BaseStorage<SchemasCreate>>