Skip to main content

LogBuffer

@webda/debug

Class: LogBuffer

Defined in: debug/src/logbuffer.ts:30

Ring buffer that captures application logs from WorkerOutput and notifies subscribers of new entries in real time.

Constructors​

Constructor​

new LogBuffer(maxSize?): LogBuffer

Defined in: debug/src/logbuffer.ts:42

Create a new LogBuffer.

Parameters​

maxSize?​

number = 2000

Maximum number of entries to retain (oldest are evicted)

Returns​

LogBuffer

Methods​

getEntries()​

getEntries(): LogEntry[]

Defined in: debug/src/logbuffer.ts:94

Return a shallow copy of all stored entries.

Returns​

LogEntry[]

array of log entries

onEvent()​

onEvent(callback): () => void

Defined in: debug/src/logbuffer.ts:127

Register a callback for new log events.

Parameters​

callback​

LogEventCallback

function invoked on each new log event

Returns​

unsubscribe function

() => void

search(query): LogEntry[]

Defined in: debug/src/logbuffer.ts:108

Filter entries by query. If the query matches a log level name, filter by severity (>= that level). Otherwise, do a text search on message and level.

Parameters​

query​

string

search string or log level name

Returns​

LogEntry[]

matching entries

subscribe()​

subscribe(): void

Defined in: debug/src/logbuffer.ts:75

Start listening to WorkerOutput messages.

Returns​

void

unsubscribe()​

unsubscribe(): void

Defined in: debug/src/logbuffer.ts:82

Stop listening to WorkerOutput messages.

Returns​

void