Options
All
  • Public
  • Public/Protected
  • All
Menu

Class LogEntryAPI

An API to retrieve data from the LogEntry store

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

  • new LogEntryAPI(logEntryStore: typeof LogEntry): LogEntryAPI

Properties

Private store

store: typeof LogEntry

The LogEntry store

Methods

findLogEntries

  • findLogEntries(limit: number, offset: number, table: string | undefined): Promise<LogEntriesResponse>

Optional initialize

  • initialize(config: DataSourceConfig<ContextBase>): void | Promise<void>

  • Parameters

    Returns void | Promise<void>

insertLogEntry

  • insertLogEntry(__namedParameters: { description: string; newValue: Record<string, unknown>; oldValue: Record<string, unknown>; table: string; who: undefined | string }, transaction: Transaction): Promise<LogEntryAttributes>

  • Insert a new log entry

    async

    Parameters

    • __namedParameters: { description: string; newValue: Record<string, unknown>; oldValue: Record<string, unknown>; table: string; who: undefined | string }
      • description: string
      • newValue: Record<string, unknown>
      • oldValue: Record<string, unknown>
      • table: string
      • who: undefined | string
    • transaction: Transaction

      The database transaction

    Returns Promise<LogEntryAttributes>

Generated using TypeDoc