Class Collection<D>

constructor

• new Collection<D = Data>(
      db: ValtheraCompatible,
      collection: string,
  ): Collection<D>

  Type Parameters

  • D = Data

  Parameters

  • db: ValtheraCompatible
  • collection: string

  Returns Collection<D>

collection

db

add

• add(data: Arg<D>, id_gen: false): Promise<D>

  Add data to a database.

  Parameters

  • data: Arg<D>
  • id_gen: false

  Returns Promise<D>

• add(data: Arg<D>, id_gen?: true): Promise<D & { _id: string }>

  Add data to a database.

  Parameters

  • data: Arg<D>
  • Optionalid_gen: true

  Returns Promise<D & { _id: string }>

bulkAdd

• bulkAdd(data: Arg<D>[], id_gen: false): Promise<D[]>

  Parameters

  • data: Arg<D>[]
  • id_gen: false

  Returns Promise<D[]>

• bulkAdd(data: Arg<D>[], id_gen?: true): Promise<(D & { _id: string })[]>

  Parameters

  • data: Arg<D>[]
  • Optionalid_gen: true

  Returns Promise<(D & { _id: string })[]>

count

• count(search?: SearchOptions<D>): Promise<number>

  Count data entries in a database.

  Parameters

  • search: SearchOptions<D> = {}

  Returns Promise<number>

createIndex

• createIndex(fields: string[], opts?: IndexOpts): Promise<void>

  Create an index on this collection.

  Parameters

  • fields: string[]
  • Optionalopts: IndexOpts

  Returns Promise<void>

find

• find(
      search?: SearchOptions<D> | SearchFunc<D>,
      options?: DbFindOpts<D>,
      findOpts?: FindOpts<D>,
      context?: VContext,
  ): Promise<D[]>

  Find data in a database.

  Parameters

  • search: SearchOptions<D> | SearchFunc<D> = {}
  • options: DbFindOpts<D> = {}
  • findOpts: FindOpts<D> = {}
  • context: VContext = {}

  Returns Promise<D[]>

findOne

• findOne(
      search?: SearchOptions<D> | SearchFunc<D>,
      findOpts?: FindOpts<D>,
      context?: VContext,
  ): Promise<D | null>

  Find one data entry in a database.

  Parameters

  • search: SearchOptions<D> | SearchFunc<D> = {}
  • findOpts: FindOpts<D> = {}
  • context: VContext = {}

  Returns Promise<D | null>

remove

• remove(
      search: SearchOptions<D> | SearchFunc<D>,
      context?: VContext,
  ): Promise<D[]>

  Remove data from a database.

  Parameters

  • search: SearchOptions<D> | SearchFunc<D>
  • context: VContext = {}

  Returns Promise<D[]>

removeIndex

• removeIndex(fields: string[]): Promise<void>

  Remove an index from this collection. Adapter-dependent.

  Parameters

  • fields: string[]

  Returns Promise<void>

removeOne

• removeOne(
      search: SearchOptions<D> | SearchFunc<D>,
      context?: VContext,
  ): Promise<D | null>

  Remove one data entry from a database.

  Parameters

  • search: SearchOptions<D> | SearchFunc<D>
  • context: VContext = {}

  Returns Promise<D | null>

toggleOne

• toggleOne(
      search: SearchOptions<D> | SearchFunc<D>,
      data?: Arg<D>,
      context?: VContext,
  ): Promise<ToggleOneResult<D>>

  Asynchronously removes one entry in a database or adds a new one if it doesn't exist. Usage e.g. for toggling a flag.

  Parameters

  • search: SearchOptions<D> | SearchFunc<D>
  • data: Arg<D> = {}
  • context: VContext = {}

  Returns Promise<ToggleOneResult<D>>

update

• update(
      search: SearchOptions<D> | SearchFunc<D>,
      updater: UpdaterArg<D> | UpdaterFunc<D>,
      context?: VContext,
  ): Promise<D[]>

  Update data in a database.

  Parameters

  • search: SearchOptions<D> | SearchFunc<D>
  • updater: UpdaterArg<D> | UpdaterFunc<D>
  • context: VContext = {}

  Returns Promise<D[]>

updateOne

• updateOne(
      search: SearchOptions<D> | SearchFunc<D>,
      updater: UpdaterArg<D> | UpdaterFunc<D>,
      context?: VContext,
  ): Promise<D | null>

  Update one data entry in a database.

  Parameters

  • search: SearchOptions<D> | SearchFunc<D>
  • updater: UpdaterArg<D> | UpdaterFunc<D>
  • context: VContext = {}

  Returns Promise<D | null>

updateOneOrAdd

• updateOneOrAdd(
      search: SearchOptions<D> | SearchFunc<D>,
      updater: UpdaterArg<D> | UpdaterFunc<D>,
      __namedParameters?: UpdateOneOrAdd<D>,
  ): Promise<UpdateOneOrAddResult<D>>

  Asynchronously updates one entry in a database or adds a new one if it doesn't exist.

  Parameters

  • search: SearchOptions<D> | SearchFunc<D>
  • updater: UpdaterArg<D> | UpdaterFunc<D>
  • __namedParameters: UpdateOneOrAdd<D> = {}

  Returns Promise<UpdateOneOrAddResult<D>>