Skip to main content

ActionMemoryLogger

@webda/async • Readme | API

Class: ActionMemoryLogger

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

Extends​

  • MemoryLogger

Constructors​

new ActionMemoryLogger(output, level, limit, actionOrSaver, logSaveDelay, format)​

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

Parameters​

• output: WorkerOutput

to connect to

• level: WorkerLogLevel

of logs

• limit: number

the size of the log

• actionOrSaver: AsyncAction | (logs) => Promise<void>

the action to save the logs to or a function to save the logs

• logSaveDelay: number

delay before saving the logs

• format?: string

format of the logs

Returns​

ActionMemoryLogger

Overrides​

MemoryLogger.constructor

Source​

async/src/services/servicerunner.ts:40

Properties​

format?​

format?: string

format of the logs

Source​

async/src/services/servicerunner.ts:46

includeAll​

protected includeAll: boolean

Also store other message than logs if true

Inherited from​

MemoryLogger.includeAll

Source​

workout/lib/loggers/memory.d.ts:14

level​

level: WorkerLogLevel

Inherited from​

MemoryLogger.level

Source​

workout/lib/loggers/index.d.ts:6

limit​

protected limit: number

Max number of messages kept

Inherited from​

MemoryLogger.limit

Source​

workout/lib/loggers/memory.d.ts:18

listener​

listener: (msg) => void

Parameters​

• msg: WorkerMessage

Returns​

void

Inherited from​

MemoryLogger.listener

Source​

workout/lib/loggers/index.d.ts:7

logSaveDelay​

logSaveDelay: number

delay before saving the logs

Source​

async/src/services/servicerunner.ts:45

messages​

protected messages: WorkerMessage[]

Messages received

Inherited from​

MemoryLogger.messages

Source​

workout/lib/loggers/memory.d.ts:10

output​

output: WorkerOutput

Inherited from​

MemoryLogger.output

Source​

workout/lib/loggers/index.d.ts:8

saver​

protected saver: (logs) => Promise<void>

Parameters​

• logs: string[]

Returns​

Promise<void>

Source​

async/src/services/servicerunner.ts:29

timeout​

protected timeout: Timeout

Source​

async/src/services/servicerunner.ts:28

Methods​

clear()​

clear(): void

Clear all messages

Returns​

void

Inherited from​

MemoryLogger.clear

Source​

workout/lib/loggers/memory.d.ts:36

clearTimeout()​

clearTimeout(): void

Clear the timeout

Returns​

void

Source​

async/src/services/servicerunner.ts:78

close()​

close(clearTimeout): void

Close the logger

Parameters​

• clearTimeout: boolean= false

clear the timeout

Returns​

void

Overrides​

MemoryLogger.close

Source​

async/src/services/servicerunner.ts:90

getFormattedLogs()​

getFormattedLogs(): string[]

Returns the formatted logs based on this.format

Returns​

string[]

Source​

async/src/services/servicerunner.ts:101

getLogs()​

getLogs(): WorkerMessage[]

Get all logs messages

Returns​

WorkerMessage[]

Inherited from​

MemoryLogger.getLogs

Source​

workout/lib/loggers/memory.d.ts:32

getMessages()​

getMessages(): WorkerMessage[]

Get all messages recorded

Returns​

WorkerMessage[]

Inherited from​

MemoryLogger.getMessages

Source​

workout/lib/loggers/memory.d.ts:28

onMessage()​

onMessage(msg): void

Parameters​

• msg: WorkerMessage

Returns​

void

Overrides​

MemoryLogger.onMessage

Inherit Doc​

Source​

async/src/services/servicerunner.ts:59

save()​

save(): Promise<void>

Save the logs to the action

Returns​

Promise<void>

Source​

async/src/services/servicerunner.ts:70

saveAndClose()​

saveAndClose(): Promise<void>

Save the logs and close the logger

Returns​

Promise<void>

Source​

async/src/services/servicerunner.ts:109

setLogLevel()​

setLogLevel(level): void

Set LogLevel

Parameters​

• level: WorkerLogLevel

Returns​

void

Inherited from​

MemoryLogger.setLogLevel

Source​

workout/lib/loggers/memory.d.ts:24