Class ValtheraClass

Represents a database management class for performing CRUD operations.

Hierarchy (View Summary)

ValtheraClass
- ValtheraMemory

Implements

ValtheraCompatible

Index

Constructors

constructor

Properties

_collections _plugins adapter emitter executor options version

Constructors

constructor

new ValtheraClass(options: DbOpts): ValtheraClass
Parameters
- options: DbOpts
Returns ValtheraClass
- Defined in db/valthera.ts:69

Properties

_collections

_collections: Map<string, Collection<any>> = ...

_plugins

_plugins: ValtheraPlugin[] = []

adapter

adapter: ActionsBase

emitter

emitter: VEE<
    {
        add(query: VQuery, result: unknown): void;
        bulkAdd(query: VQuery, result: unknown[]): void;
        count(query: VQuery, result: number): void;
        createIndex(query: VQuery, result: void): void;
        ensureCollection(query: VQuery, result: boolean): void;
        find(query: VQuery, result: unknown[]): void;
        findOne(query: VQuery, result: unknown): void;
        getCollections(query: VQuery, result: string[]): void;
        issetCollection(query: VQuery, result: boolean): void;
        remove(query: VQuery, result: unknown[]): void;
        removeCollection(query: VQuery, result: boolean): void;
        removeIndex(query: VQuery, result: void): void;
        removeOne(query: VQuery, result: unknown): void;
        toggleOne(query: VQuery, result: ToggleOneResult<unknown>): void;
        update(query: VQuery, result: unknown[]): void;
        updateOne(query: VQuery, result: unknown): void;
        updateOneOrAdd(query: VQuery, result: UpdateOneOrAddResult<unknown>): void;
    } & {
        "*": (
            name:
                | "find"
                | "count"
                | "getCollections"
                | "ensureCollection"
                | "issetCollection"
                | "add"
                | "findOne"
                | "update"
                | "updateOne"
                | "remove"
                | "removeOne"
                | "removeCollection"
                | "updateOneOrAdd"
                | "toggleOne"
                | "createIndex"
                | "removeIndex"
                | "bulkAdd",
            query: VQuery,
            result: any,
        ) => void;
    },
> = ...

executor

executor: ExecutorInterface

options

options: DbOpts

version

version: string = version

Methods

add

add<T = Data>(query: Add<T>): Promise<T>
Add data to a database.
Type Parameters
- T = Data
Parameters
- query: Add<T>
Returns Promise<T>
Implementation of ValtheraCompatible.add
- Defined in db/valthera.ts:194

bulkAdd

bulkAdd<T = Data>(query: BulkAdd<T>): Promise<T[]>
Type Parameters
- T = Data
Parameters
- query: BulkAdd<T>
Returns Promise<T[]>
Implementation of ValtheraCompatible.bulkAdd
- Defined in db/valthera.ts:199

c

c<T = Data>(collection: string): Collection<T>
Create a new instance of a Collection class.
Type Parameters
- T = Data
Parameters
- collection: string
Returns Collection<T>
Implementation of ValtheraCompatible.c
- Defined in db/valthera.ts:162

close

close(...args: any[]): Promise<any>
Parameters
- ...args: any[]
Returns Promise<any>
- Defined in db/valthera.ts:113

count

count(query: Count): Promise<number>
Parameters
- query: Count
Returns Promise<number>
Implementation of ValtheraCompatible.count
- Defined in db/valthera.ts:308

createIndex

createIndex(
    collection: string,
    fields: string[],
    opts?: IndexOpts,
): Promise<void>
Create an index on a collection.
Parameters
- collection: string
- fields: string[]
- Optionalopts: IndexOpts
Returns Promise<void>
Implementation of ValtheraCompatible.createIndex
- Defined in db/valthera.ts:282

ensureCollection

ensureCollection(collection: string): Promise<boolean>
Check and create the specified collection if it doesn't exist.
Parameters
- collection: string
Returns Promise<boolean>
Implementation of ValtheraCompatible.ensureCollection
- Defined in db/valthera.ts:180

execute

execute<T>(
    name: keyof ValtheraCompatible,
    query: string | VQuery<any, true>,
    txHandle?: TransactionHandle,
): Promise<T>
Type Parameters
- T
Parameters
- name: keyof ValtheraCompatible
- query: string | VQuery<any, true>
- OptionaltxHandle: TransactionHandle
Returns Promise<T>
- Defined in db/valthera.ts:123

find

find<T = Data>(query: Find<T>): Promise<T[]>
Find data in a database.
Type Parameters
- T = Data
Parameters
- query: Find<T>
Returns Promise<T[]>
Implementation of ValtheraCompatible.find
- Defined in db/valthera.ts:207

findOne

findOne<T = Data>(query: FindOne<T>): Promise<T | null>
Find one data entry in a database.
Type Parameters
- T = Data
Parameters
- query: FindOne<T>
Returns Promise<T | null>
Implementation of ValtheraCompatible.findOne
- Defined in db/valthera.ts:215

getCollections

getCollections(): Promise<string[]>
Get the names of all available databases.

Returns Promise<string[]>
Implementation of ValtheraCompatible.getCollections
- Defined in db/valthera.ts:173

init

init(...args: any[]): Promise<any>
Parameters
- ...args: any[]
Returns Promise<any>
- Defined in db/valthera.ts:82

issetCollection

issetCollection(collection: string): Promise<boolean>
Check if a collection exists.
Parameters
- collection: string
Returns Promise<boolean>
Implementation of ValtheraCompatible.issetCollection
- Defined in db/valthera.ts:187

plugin

plugin(p: ValtheraPlugin, collections?: string | string[]): () => void
Parameters
- p: ValtheraPlugin
- Optionalcollections: string | string[]
Returns () => void
- Defined in db/valthera.ts:53

remove

remove<T = Data>(query: Remove<T>): Promise<T[]>
Remove data from a database.
Type Parameters
- T = Data
Parameters
- query: Remove<T>
Returns Promise<T[]>
Implementation of ValtheraCompatible.remove
- Defined in db/valthera.ts:239

removeCollection

removeCollection(collection: string): Promise<boolean>
Removes a database collection from the database.
Parameters
- collection: string
Returns Promise<boolean>
Implementation of ValtheraCompatible.removeCollection
- Defined in db/valthera.ts:274

removeIndex

removeIndex(collection: string, fields: string[]): Promise<void>
Remove an index from a collection. Adapter-dependent.
Parameters
- collection: string
- fields: string[]
Returns Promise<void>
Implementation of ValtheraCompatible.removeIndex
- Defined in db/valthera.ts:297

removeOne

removeOne<T = Data>(query: Remove<T>): Promise<T | null>
Remove one data entry from a database.
Type Parameters
- T = Data
Parameters
- query: Remove<T>
Returns Promise<T | null>
Implementation of ValtheraCompatible.removeOne
- Defined in db/valthera.ts:247

toggleOne

toggleOne<T = Data>(query: ToggleOne<T>): Promise<ToggleOneResult<T>>
Asynchronously removes one entry in a database or adds a new one if it doesn't exist. Usage e.g. for toggling a flag.
Type Parameters
- T = Data
Parameters
- query: ToggleOne<T>
Returns Promise<ToggleOneResult<T>>
Implementation of ValtheraCompatible.toggleOne
- Defined in db/valthera.ts:266

transaction

transaction<T>(
collections: string[],
fn: (tx: Transaction) => Promise<T>,
): Promise<T>
Experimental
Executes operations within a transaction. Automatically rolls back on error.

Receives a transaction-scoped object (tx) whose operations are executed within the transaction context.

This feature is highly experimental and may change or be removed at any time.
- Transaction support depends on the adapter implementation.
- Collections must be declared upfront to ensure proper locking.
- Operations invoked via the original db reference are NOT part of the transaction.
Type Parameters
- T
Parameters
- collections: string[]
- fn: (tx: Transaction) => Promise<T>
Returns Promise<T>
- Defined in db/valthera.ts:327

update

update<T = Data>(query: Update<T>): Promise<T[]>
Update data in a database.
Type Parameters
- T = Data
Parameters
- query: Update<T>
Returns Promise<T[]>
Implementation of ValtheraCompatible.update
- Defined in db/valthera.ts:223

updateOne

updateOne<T = Data>(query: Update<T>): Promise<T | null>
Update one data entry in a database.
Type Parameters
- T = Data
Parameters
- query: Update<T>
Returns Promise<T | null>
Implementation of ValtheraCompatible.updateOne
- Defined in db/valthera.ts:231

updateOneOrAdd

updateOneOrAdd<T = Data>(
query: VQueryT.UpdateOneOrAdd<T>,
): Promise<UpdateOneOrAddResult<T>>
Asynchronously updates one entry in a database or adds a new one if it doesn't exist.
Type Parameters
- T = Data
Parameters
- query: VQueryT.UpdateOneOrAdd<T>
Returns Promise<UpdateOneOrAddResult<T>>
Implementation of ValtheraCompatible.updateOneOrAdd
- Defined in db/valthera.ts:255

Class ValtheraClass

Hierarchy (View Summary)

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns ValtheraClass

Properties

_collections

_plugins

adapter

emitter

executor

options

version

Methods

add

Type Parameters

Parameters

Returns Promise<T>

bulkAdd

Type Parameters

Parameters

Returns Promise<T[]>

c

Type Parameters

Parameters

Returns Collection<T>

close

Parameters

Returns Promise<any>

count

Parameters

Returns Promise<number>

createIndex

Parameters

Returns Promise<void>

ensureCollection

Parameters

Returns Promise<boolean>

execute

Type Parameters

Parameters

Returns Promise<T>

find

Type Parameters

Parameters

Returns Promise<T[]>

findOne

Type Parameters

Parameters

Returns Promise<T | null>

getCollections

Returns Promise<string[]>

init

Parameters

Returns Promise<any>

issetCollection

Parameters

Returns Promise<boolean>

plugin

Parameters

Returns () => void

remove

Type Parameters

Parameters

Returns Promise<T[]>

removeCollection

Parameters

Returns Promise<boolean>

removeIndex

Parameters

Returns Promise<void>

removeOne

Type Parameters

Parameters