Skip to content

Interface: Logger ​

Defined in: netconf/src/logger.ts:9

Where the library logs, given as connect({ logger }). Every method is optional, so console, a pino or winston adapter, or a partial object all work. Nothing is logged unless a logger is supplied. See Logging and tracing.

Methods ​

debug()? ​

ts
debug?(message, context?): void;

Defined in: netconf/src/logger.ts:13

Session events worth knowing when debugging, such as the session opening or the profile chosen.

Parameters ​

message ​

string

context? ​

Record<string, unknown>

Returns ​

void


error()? ​

ts
error?(message, context?): void;

Defined in: netconf/src/logger.ts:19

An error the library can't report any other way, such as an event listener that threw.

Parameters ​

message ​

string

context? ​

Record<string, unknown>

Returns ​

void


info()? ​

ts
info?(message, context?): void;

Defined in: netconf/src/logger.ts:15

Informational messages; the library doesn't log at this level yet.

Parameters ​

message ​

string

context? ​

Record<string, unknown>

Returns ​

void


trace()? ​

ts
trace?(message, context?): void;

Defined in: netconf/src/logger.ts:11

Every message sent and received, with its XML (redacted).

Parameters ​

message ​

string

context? ​

Record<string, unknown>

Returns ​

void


warn()? ​

ts
warn?(message, context?): void;

Defined in: netconf/src/logger.ts:17

Something unexpected that didn't fail the call, such as a session warning or failed cleanup.

Parameters ​

message ​

string

context? ​

Record<string, unknown>

Returns ​

void

Released under the MIT Licence.