Skip to content

Home > @opengovsg/logging > AuditInputBase

AuditInputBase interface ​

Fields every audit input accepts in addition to its event-specific shape.

Signature:

typescript
export interface AuditInputBase

Properties ​

PropertyModifiersTypeDescription
context?AuditContext(Optional) Optional free-form business fields, merged into the context field.
messageOverride?string(Optional) Override the event's **stable default** message (e.g. loginSucceeded defaults to "Login succeeded"). Omit to use that default — the key is named messageOverride precisely to signal a default already exists. Prefer the default unless a call site genuinely needs a more specific human message; grouping/filtering keys off event/category, not the message.