Class UserActivityStore

Readonlydb

convertTo

• convertTo<T, O>(func: (input: T) => O): (doc: T) => O

  Convenience method to convert a document to something.

  Type Parameters

  • T
  • O

  Parameters

  • func: (input: T) => O

    The function which will be called with a single document object. Guaranteed not to be null.

  Returns (doc: T) => O

  A transformFn function to pass to the standard select/delete/upsert/etc methods.

delete

• delete(query: Query): Promise<number>

  DELETE multiple documents.

  Parameters

  • query: Query

  Returns Promise<number>

insert

• insert(objects: unknown): Promise<any[]>

  INSERT a multiple documents.

  Parameters

  • objects: unknown

  Returns Promise<any[]>

insertIfNotExists

• insertIfNotExists(
      query: Query,
      insertObj: Record<string, unknown>,
  ): Promise<void>

  INSERT IF NOT EXISTS a single document

  Parameters

  • query: Query
  • insertObj: Record<string, unknown>

  Returns Promise<void>

select

• select<T, O>(query: Query, transformFn?: (input: T) => O): Promise<O[]>

  SELECT a number of documents.

  Type Parameters

  • T
  • O

  Parameters

  • query: Query
  • OptionaltransformFn: (input: T) => O

  Returns Promise<O[]>

selectOne

• selectOne<T, O>(query: Query, transformFn?: (input: T) => O): Promise<O | null>

  SELECT a single document.

  Type Parameters

  • T
  • O

  Parameters

  • query: Query
  • OptionaltransformFn: (input: T) => O

  Returns Promise<O | null>

setUnique

• setUnique(fieldName: string, sparse?: boolean): Promise<void>

  Set a UNIQUE key constraint on the given field.

  Parameters

  • fieldName: string

    The field name. Use dot notation for nested objects.

  • sparse: boolean = false

    Allow sparse entries (undefined won't cause a key violation).

  Returns Promise<void>

update

• update(query: Query, updateVals: Record<string, unknown>): Promise<number>

  UPDATE a single document. If the document already exists, this will NOT update it.

  Parameters

  • query: Query
  • updateVals: Record<string, unknown>

  Returns Promise<number>

upsert

• upsert<T>(query: Query, updateVals: T): Promise<number>

  UPSERT a single document

  Type Parameters

  • T

  Parameters

  • query: Query
  • updateVals: T

  Returns Promise<number>