Skip to main content

Interface: AuditOptions

Defined in: src/audit/AuditMetadata.ts:4

Options for the @Auditable class decorator.

Properties​

changelog?​

optional changelog?: boolean

Defined in: src/audit/AuditMetadata.ts:10

When true, every INSERT, UPDATE, and DELETE on this entity is written as a row in the _audit_log table (or the custom tableName below).

Default​

false

tableName?​

optional tableName?: string

Defined in: src/audit/AuditMetadata.ts:16

Override the target audit log table name.

Default​

'_audit_log'

includeOld?​

optional includeOld?: boolean

Defined in: src/audit/AuditMetadata.ts:22

When true, the oldValues snapshot is captured before UPDATE/DELETE.

Default​

true