Class AuditLog

Index

Constructors

Methods

append byteSize clear countByKind exportJson hydrate list size subscribe

Constructors

constructor

new AuditLog(opts?: AuditLogOptions): AuditLog
Parameters
- Optionalopts: AuditLogOptions
Returns AuditLog

Methods

append

append(event: AuditEventInput): AuditEvent
Append an event. seq and ts are assigned by the log; any caller-supplied values are overwritten. The input type uses distributive Omit so each event-kind's unique fields stay visible to TypeScript (no need for as casts at call sites).
Parameters
- event: AuditEventInput
Returns AuditEvent

byteSize

byteSize(): number

Approximate in-memory footprint, in JSON bytes.

Returns number

clear

clear(): void

Reset everything.

Returns void

countByKind

countByKind(filter?: AuditFilter): Record<AuditEventKind, number>
Counter snapshot by kind — useful for dashboards.
Parameters
- Optionalfilter: AuditFilter
Returns Record<AuditEventKind, number>

exportJson

exportJson(): string

Export the entire log as a pretty-printed JSON string.

Returns string

hydrate

hydrate(events: readonly AuditEvent[]): void
Hydrate the log from a prior snapshot (typically from IDB). Used when the viewer's host service restores state on app boot. The eviction policy still runs after hydration so an over-cap import gets trimmed.
Parameters
- events: readonly AuditEvent[]
Returns void

list

list(filter?: AuditFilter): AuditEvent[]
List events matching the filter, oldest first.
Parameters
- Optionalfilter: AuditFilter
Returns AuditEvent[]

size

size(): number

Current event count.

Returns number

subscribe(listener: (event: AuditEvent) => void): () => void
Subscribe to new audit events; returns an unsubscribe.
Parameters
- listener: (event: AuditEvent) => void
Returns () => void