Class default<D>

Type Parameters

D = Data

Index

Constructors

Methods

add find findOne remove removeOne toggleOne update updateOne updateOneOrAdd

Constructors

constructor

new default<D = Data>(db: ValtheraCompatible, collection: string): default<D>
Type Parameters
- D = Data
Parameters
- db: ValtheraCompatible
- collection: string
Returns default<D>
- Defined in helpers/CollectionManager.ts:8

Methods

add

add<T = Data>(data: Arg<T & D>, id_gen?: boolean): Promise<T>
Add data to a database.
Type Parameters
- T = Data
Parameters
- data: Arg<T & D>
- id_gen: boolean = true
Returns Promise<T>
- Defined in helpers/CollectionManager.ts:13

find

find<T = Data>(
    search?: Search<T & D>,
    options?: DbFindOpts<T & D>,
    findOpts?: FindOpts<T & D>,
    context?: VContext,
): Promise<T[]>
Find data in a database.
Type Parameters
- T = Data
Parameters
- search: Search<T & D> = {}
- options: DbFindOpts<T & D> = {}
- findOpts: FindOpts<T & D> = {}
- context: VContext = {}
Returns Promise<T[]>
- Defined in helpers/CollectionManager.ts:20

findOne

findOne<T = Data>(
    search?: Search<T & D>,
    findOpts?: FindOpts<T & D>,
    context?: VContext,
): Promise<T>
Find one data entry in a database.
Type Parameters
- T = Data
Parameters
- search: Search<T & D> = {}
- findOpts: FindOpts<T & D> = {}
- context: VContext = {}
Returns Promise<T>
- Defined in helpers/CollectionManager.ts:27

remove

remove<T = Data>(search: Search<T & D>, context?: VContext): Promise<boolean>
Remove data from a database.
Type Parameters
- T = Data
Parameters
- search: Search<T & D>
- context: VContext = {}
Returns Promise<boolean>
- Defined in helpers/CollectionManager.ts:48

removeOne

removeOne<T = Data>(search: Search<T & D>, context?: VContext): Promise<boolean>
Remove one data entry from a database.
Type Parameters
- T = Data
Parameters
- search: Search<T & D>
- context: VContext = {}
Returns Promise<boolean>
- Defined in helpers/CollectionManager.ts:55

toggleOne

toggleOne<T = Data>(
    search: Search<T & D>,
    data?: Arg<T & D>,
    context?: VContext,
): Promise<boolean>
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
- search: Search<T & D>
- data: Arg<T & D> = {}
- context: VContext = {}
Returns Promise<boolean>
- Defined in helpers/CollectionManager.ts:77

update

update<T = Data>(
    search: Search<T & D>,
    updater: Updater<T & D>,
    context?: VContext,
): Promise<boolean>
Update data in a database.
Type Parameters
- T = Data
Parameters
- search: Search<T & D>
- updater: Updater<T & D>
- context: VContext = {}
Returns Promise<boolean>
- Defined in helpers/CollectionManager.ts:34

updateOne

updateOne<T = Data>(
    search: Search<T & D>,
    updater: Updater<T & D>,
    context?: VContext,
): Promise<boolean>
Update one data entry in a database.
Type Parameters
- T = Data
Parameters
- search: Search<T & D>
- updater: Updater<T & D>
- context: VContext = {}
Returns Promise<boolean>
- Defined in helpers/CollectionManager.ts:41

updateOneOrAdd

updateOneOrAdd<T = Data>(
    search: Search<T & D>,
    updater: Updater<T & D>,
    __namedParameters?: UpdateOneOrAdd<T & D>,
): Promise<boolean>
Asynchronously updates one entry in a database or adds a new one if it doesn't exist.
Type Parameters
- T = Data
Parameters
- search: Search<T & D>
- updater: Updater<T & D>
- __namedParameters: UpdateOneOrAdd<T & D> = {}
Returns Promise<boolean>
- Defined in helpers/CollectionManager.ts:62