Class ValtheraClass

Represents a database management class for performing CRUD operations.

Hierarchy (View Summary)

ValtheraClass
- ValtheraMemory

Implements

ValtheraCompatible

Index

Constructors

constructor

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

Properties

dbAction

dbAction: ActionsBase

emiter

emiter: VEE<
    {
        add(query: VQuery, result: unknown): void;
        c(query: VQuery, result: Collection<unknown>): 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;
        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: keyof ValtheraCompatible,
            query: VQuery,
            result: any,
        ) => void;
    },
> = ...

executor

executor: Executor

version

version: string = version

Methods

add

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

c

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

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:83

execute

execute<T>(name: keyof ValtheraCompatible, query: VQuery<any>): Promise<T>
Type Parameters
- T
Parameters
- name: keyof ValtheraCompatible
- query: VQuery<any>
Returns Promise<T>
- Defined in db/valthera.ts:59

find

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

findOne

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

getCollections

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

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

init

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

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:90

remove

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

removeCollection

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

removeOne

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

toggleOne

toggleOne<T = Data>(query: ToggleOneQuery<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. Returns a promise resolving to false if the entry was found and removed, or true if the entry was added. The returned value reflects the state of the database after the operation.
Type Parameters
- T = Data
Parameters
- query: ToggleOneQuery<T>
Returns Promise<ToggleOneResult<T>>
Implementation of ValtheraCompatible.toggleOne
- Defined in db/valthera.ts:178

update

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

updateOne

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

updateOneOrAdd

updateOneOrAdd<T = Data>(
query: UpdateOneOrAddQuery<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: UpdateOneOrAddQuery<T>
Returns Promise<UpdateOneOrAddResult<T>>
Implementation of ValtheraCompatible.updateOneOrAdd
- Defined in db/valthera.ts:164

Class ValtheraClass

Hierarchy (View Summary)

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns ValtheraClass

Properties

dbAction

emiter

executor

version

Methods

add

Type Parameters

Parameters

Returns Promise<T>

c

Type Parameters

Parameters

Returns Collection<T>

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>

getCollections

Returns Promise<string[]>

init

Parameters

Returns Promise<unknown>

issetCollection

Parameters

Returns Promise<boolean>

remove

Type Parameters

Parameters

Returns Promise<T[]>

removeCollection

Parameters

Returns Promise<boolean>

removeOne

Type Parameters

Parameters

Returns Promise<T>

toggleOne

Type Parameters

Parameters

Returns Promise<ToggleOneResult<T>>

update

Type Parameters

Parameters

Returns Promise<T[]>

updateOne

Type Parameters

Parameters

Returns Promise<T>

updateOneOrAdd

Type Parameters

Parameters

Returns Promise<UpdateOneOrAddResult<T>>

Settings

On This Page