Skip to main content

ActionMemoryLogger

@webda/async

Class: ActionMemoryLogger

Defined in: packages/async/src/services/servicerunner.service.ts:44

Keep log in memory and save it to the action object every 5s

Extends​

  • MemoryLogger

Constructors​

Constructor​

new ActionMemoryLogger(output, level, limit, action, logSaveDelay, format?): ActionMemoryLogger

Defined in: packages/async/src/services/servicerunner.service.ts:55

Parameters​

output​

WorkerOutput

the worker output to listen to

level​

WorkerLogLevel

the log level

limit​

number

the maximum number of logs

action​

ActionLogTarget

the action to save logs to

logSaveDelay​

number

delay before saving logs

format?​

string

the log format

Returns​

ActionMemoryLogger

Overrides​

MemoryLogger.constructor

Properties​

action​

protected action: ActionLogTarget

Defined in: packages/async/src/services/servicerunner.service.ts:59

the action to save logs to

format?​

optional format?: string

Defined in: packages/async/src/services/servicerunner.service.ts:61

the log format

includeAll​

protected includeAll: boolean

Defined in: packages/workout/lib/loggers/memory.d.ts:24

Whether to store all message types (true) or only log messages (false)

Inherited from​

MemoryLogger.includeAll

level​

level: () => WorkerLogLevel

Defined in: packages/workout/lib/loggers/index.d.ts:8

Function that returns the current log level (allows dynamic level changes)

Returns​

WorkerLogLevel

Inherited from​

MemoryLogger.level

limit​

protected limit: number

Defined in: packages/workout/lib/loggers/memory.d.ts:28

Maximum number of messages to keep in memory

Inherited from​

MemoryLogger.limit

listener​

listener: (msg) => void

Defined in: packages/workout/lib/loggers/index.d.ts:10

Message listener function attached to the WorkerOutput

Parameters​

msg​

WorkerMessage

Returns​

void

Inherited from​

MemoryLogger.listener

logSaveDelay​

logSaveDelay: number

Defined in: packages/async/src/services/servicerunner.service.ts:60

delay before saving logs

messages​

protected messages: WorkerMessage[]

Defined in: packages/workout/lib/loggers/memory.d.ts:20

Messages received and stored in memory

Inherited from​

MemoryLogger.messages

output​

output: WorkerOutput

Defined in: packages/workout/lib/loggers/index.d.ts:12

The WorkerOutput instance this logger is attached to

Inherited from​

MemoryLogger.output

timeout​

protected timeout: Timeout

Defined in: packages/async/src/services/servicerunner.service.ts:45

Methods​

clear()​

clear(): void

Defined in: packages/workout/lib/loggers/memory.d.ts:60

Clear all messages

Returns​

void

Inherited from​

MemoryLogger.clear

close()​

close(): void

Defined in: packages/workout/lib/loggers/index.d.ts:43

Stop listening to messages and remove the listener

Returns​

void

Inherited from​

MemoryLogger.close

getLogs()​

getLogs(): WorkerMessage[]

Defined in: packages/workout/lib/loggers/memory.d.ts:56

Get only log messages, filtering out other message types

Returns​

WorkerMessage[]

Array of log messages only

Inherited from​

MemoryLogger.getLogs

getMessages()​

getMessages(): WorkerMessage[]

Defined in: packages/workout/lib/loggers/memory.d.ts:51

Get all messages stored in memory

Returns​

WorkerMessage[]

Array of all recorded messages

Inherited from​

MemoryLogger.getMessages

onMessage()​

onMessage(msg): void

Defined in: packages/async/src/services/servicerunner.service.ts:70

Schedule a save on each message

Parameters​

msg​

WorkerMessage

the message

Returns​

void

Overrides​

MemoryLogger.onMessage

save()​

save(): Promise<void>

Defined in: packages/async/src/services/servicerunner.service.ts:80

Save the logs to the action

Returns​

Promise<void>

saveAndClose()​

saveAndClose(): Promise<void>

Defined in: packages/async/src/services/servicerunner.service.ts:92

Close the logger and save the logs

Returns​

Promise<void>

the save promise

setLogLevel()​

setLogLevel(level): void

Defined in: packages/workout/lib/loggers/memory.d.ts:46

Update the log level for filtering future messages

Parameters​

level​

WorkerLogLevel | (() => WorkerLogLevel)

New log level as string or function

Returns​

void

Inherited from​

MemoryLogger.setLogLevel

start()​

start(): void

Defined in: packages/workout/lib/loggers/index.d.ts:39

Resume listening to messages after stopping

Returns​

void

Inherited from​

MemoryLogger.start

stop()​

stop(): void

Defined in: packages/workout/lib/loggers/index.d.ts:35

Stop listening to messages (alias for close())

Returns​

void

the result of close()

Inherited from​

MemoryLogger.stop