Skip to content

bpmn-server / Logger

Class: Logger#

A logging tool to take various message for monitoring and debugging

it can also keep the message in memory till saved later through saveToFile msgs can be cleared by the clean method

Implements#

Table of contents#

Constructors#

Properties#

Methods#

Constructors#

constructor#

• new Logger(«destructured»?): Logger

Parameters#

Name Type Default value
«destructured» Object {}
› toConsole? boolean true
› toFile? string ''
› callback? any null
› keepMessages? boolean undefined

Returns#

Logger

Defined in#

packages/bpmn-server/src/common/Logger.ts:17

Properties#

debugMsgs#

• debugMsgs: any[] = []

Defined in#

packages/bpmn-server/src/common/Logger.ts:9

toConsole#

• toConsole: boolean = true

Defined in#

packages/bpmn-server/src/common/Logger.ts:10

toFile#

• toFile: any = null

Defined in#

packages/bpmn-server/src/common/Logger.ts:11

callback#

• callback: any = null

Defined in#

packages/bpmn-server/src/common/Logger.ts:12

level#

• level: number = 0

Defined in#

packages/bpmn-server/src/common/Logger.ts:13

keepMessages#

• keepMessages: boolean = false

Keep the messages in memory for get() and save(); without it nothing accumulates (it grew with every step a server ran).

Defined in#

packages/bpmn-server/src/common/Logger.ts:15

Methods#

setOptions#

▸ setOptions(«destructured»): void

Parameters#

Name Type
«destructured» Object
› toConsole any
› toFile any
› callback any

Returns#

void

Implementation of#

ILogger.setOptions

Defined in#

packages/bpmn-server/src/common/Logger.ts:22

msg#

▸ msg(message, type?): Object

Parameters#

Name Type Default value
message any undefined
type string 'log'

Returns#

Object

Name Type
date Date
message any
type string
level number

Defined in#

packages/bpmn-server/src/common/Logger.ts:28

clear#

▸ clear(): void

Returns#

void

Implementation of#

ILogger.clear

Defined in#

packages/bpmn-server/src/common/Logger.ts:45

get#

▸ get(): any[]

Returns#

any[]

Implementation of#

ILogger.get

Defined in#

packages/bpmn-server/src/common/Logger.ts:49

info#

▸ info(...message): Object

Parameters#

Name Type
...message any[]

Returns#

Object

Name Type
date Date
message any
type string
level number

Defined in#

packages/bpmn-server/src/common/Logger.ts:53

decision#

▸ decision(...message): Object

Why the engine took a path, in words: a condition and its values, a default flow, a gateway waiting.

Parameters#

Name Type
...message any[]

Returns#

Object

Name Type
date Date
message any
type string
level number

Implementation of#

ILogger.decision

Defined in#

packages/bpmn-server/src/common/Logger.ts:57

debug#

▸ debug(...message): Object

Parameters#

Name Type
...message any[]

Returns#

Object

Name Type
date Date
message any
type string
level number

Implementation of#

ILogger.debug

Defined in#

packages/bpmn-server/src/common/Logger.ts:60

warn#

▸ warn(...message): Object

Parameters#

Name Type
...message any[]

Returns#

Object

Name Type
date Date
message any
type string
level number

Implementation of#

ILogger.warn

Defined in#

packages/bpmn-server/src/common/Logger.ts:64

log#

▸ log(...message): Object

Parameters#

Name Type
...message any[]

Returns#

Object

Name Type
date Date
message any
type string
level number

Implementation of#

ILogger.log

Defined in#

packages/bpmn-server/src/common/Logger.ts:67

logS#

▸ logS(...message): Object

Parameters#

Name Type
...message any[]

Returns#

Object

Name Type
date Date
message any
type string
level number

Defined in#

packages/bpmn-server/src/common/Logger.ts:70

logE#

▸ logE(...message): Object

Parameters#

Name Type
...message any[]

Returns#

Object

Name Type
date Date
message any
type string
level number

Defined in#

packages/bpmn-server/src/common/Logger.ts:76

toString#

▸ toString(...args): string

Parameters#

Name Type
...args any[]

Returns#

string

Defined in#

packages/bpmn-server/src/common/Logger.ts:81

reportError#

▸ reportError(err): void

Parameters#

Name Type
err any

Returns#

void

Implementation of#

ILogger.reportError

Defined in#

packages/bpmn-server/src/common/Logger.ts:113

error#

▸ error(err): void

Parameters#

Name Type
err any

Returns#

void

Implementation of#

ILogger.error

Defined in#

packages/bpmn-server/src/common/Logger.ts:132

save#

▸ save(filename, flag?): Promise\<void>

Parameters#

Name Type Default value
filename any undefined
flag string 'w'

Returns#

Promise\<void>

Implementation of#

ILogger.save

Defined in#

packages/bpmn-server/src/common/Logger.ts:135

saveForInstance#

▸ saveForInstance(instanceId): Promise\<void>

Parameters#

Name Type
instanceId any

Returns#

Promise\<void>

Implementation of#

ILogger.saveForInstance

Defined in#

packages/bpmn-server/src/common/Logger.ts:167

Comments