Class EventBridgeStore

Readonly db

convertTo

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

• Convenience method to convert a document to something.

  Type Parameters

  • T

  • O

  Parameters

  • func: ((input) => O)

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

    • • (input): O

      • Parameters

        • input: T

        Returns O

  Returns ((doc) => O)

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

  • • (doc): O

    • Parameters

      • doc: T

      Returns O

delete

• delete(query): Promise<number>

• DELETE multiple documents.

  Parameters

  • query: Query

  Returns Promise<number>

insert

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

• INSERT a multiple documents.

  Parameters

  • objects: unknown

  Returns Promise<any[]>

insertIfNotExists

• insertIfNotExists(query, insertObj): Promise<void>

• INSERT IF NOT EXISTS a single document

  Parameters

  • query: Query

  • insertObj: Record<string, unknown>

  Returns Promise<void>

select

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

• SELECT a number of documents.

  Type Parameters

  • T

  • O

  Parameters

  • query: Query

  • Optional transformFn: ((input) => O)

    • • (input): O

      • Parameters

        • input: T

        Returns O

  Returns Promise<O[]>

selectOne

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

• SELECT a single document.

  Type Parameters

  • T

  • O

  Parameters

  • query: Query

  • Optional transformFn: ((input) => O)

    • • (input): O

      • Parameters

        • input: T

        Returns O

  Returns Promise<null | O>

setUnique

• setUnique(fieldName, sparse?): 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 void

update

• update(query, updateVals): Promise<void>

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

  Parameters

  • query: Query

  • updateVals: Record<string, unknown>

  Returns Promise<void>

upsert

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

• UPSERT a single document

  Type Parameters

  • T

  Parameters

  • query: Query

  • updateVals: T

  Returns Promise<void>