Logger

Represents a logger utility for logging messages with various log levels.

Constructors

new Logger()

1
new Logger(options: LoggerOptions): Logger

Constructs a new Logger instance with the provided options.

Parameters

Parameter	Type	Description
`options`	`LoggerOptions`	The options for configuring the logger.

Returns

Logger

Source

twitchfy/packages/eventsub/src/logger/Logger.ts:94

Properties

Property	Modifier	Type	Default value	Description
`options`	`readonly`	`Required`<`LoggerOptions`>	`undefined`	The options for configuring the logger.
`DEFAULT_OPTIONS`	`static`	`Required`<`LoggerOptions`>	`...`	The default options for the logger.
`colorFunctions`	`static`	`Map`<`LogLevels`, (`str`: `string`) => `string`>	`...`	A map containing color functions for different log levels.
`dirname`	`static`	`string`	`'eventsub-logs'`	-
`prefixes`	`static`	`Map`<`LogLevels`, `string`>	`...`	A map containing prefixes for different log levels.
`saveOnFile?`	`static`	`string`[] \| `"all"`	`undefined`	-
`streams`	`static`	`Partial`<`Record`<`string`, `WriteStream`>>	`{}`	-

Accessors

active

1
get active(): boolean

Gets whether the logger is active or not.

1
set active(active: boolean): void

Sets whether the logger is active or not.

Parameters

Parameter	Type
`active`	`boolean`

Returns

boolean

Source

twitchfy/packages/eventsub/src/logger/Logger.ts:130

level

1
get level(): LogLevels

Gets the log level of the logger.

1
set level(level: LogLevels): void

Sets the log level of the logger.

Parameters

Parameter	Type
`level`	`LogLevels`

Returns

LogLevels

Source

twitchfy/packages/eventsub/src/logger/Logger.ts:108

name

1
get name(): string

Gets the name of the logger.

1
set name(name: string): void

Sets the name of the logger.

Parameters

Parameter	Type
`name`	`string`

Returns

string

Source

twitchfy/packages/eventsub/src/logger/Logger.ts:144

saveOnFile

1
get saveOnFile(): boolean

1
set saveOnFile(saveOnFile: boolean): void

Parameters

Parameter	Type
`saveOnFile`	`boolean`

Returns

boolean

Source

twitchfy/packages/eventsub/src/logger/Logger.ts:116

Methods

debug()

1
debug(...args: any[]): void

Logs a debug message.

Parameters

Parameter	Type	Description
…`args`	`any`[]	The arguments to log.

Returns

void

Source

twitchfy/packages/eventsub/src/logger/Logger.ts:182

error()

1
error(...args: any[]): void

Logs an error message.

Parameters

Parameter	Type	Description
…`args`	`any`[]	The arguments to log.

Returns

void

Source

twitchfy/packages/eventsub/src/logger/Logger.ts:206

fatal()

1
fatal(...args: any[]): void

Logs a fatal error message.

Parameters

Parameter	Type	Description
…`args`	`any`[]	The arguments to log.

Returns

void

Source

twitchfy/packages/eventsub/src/logger/Logger.ts:214

info()

1
info(...args: any[]): void

Logs an info message.

Parameters

Parameter	Type	Description
…`args`	`any`[]	The arguments to log.

Returns

void

Source

twitchfy/packages/eventsub/src/logger/Logger.ts:190

rawLog()

1
rawLog(level: LogLevels, ...args: unknown[]): void

Logs a message with the specified log level.

Parameters

Parameter	Type	Description
`level`	`LogLevels`	The log level.
…`args`	`unknown`[]	The arguments to log.

Returns

void

The logged message.

Source

twitchfy/packages/eventsub/src/logger/Logger.ts:154

warn()

1
warn(...args: any[]): void

Logs a warning message.

Parameters

Parameter	Type	Description
…`args`	`any`[]	The arguments to log.

Returns

void

Source

twitchfy/packages/eventsub/src/logger/Logger.ts:198

clearLogs()

1
static clearLogs(): Promise<void>

Returns

Promise<void>

Source

twitchfy/packages/eventsub/src/logger/Logger.ts:82

customize()

1
static customize(cb: CustomCallback): void

Allows customization of the logging behavior by providing a custom callback function.

Parameters

Parameter	Type	Description
`cb`	`CustomCallback`	The custom callback function for logging.

Returns

void

Example

1
Logger.customize((logger, level, args) => {
2
    // Custom logging implementation
3
});

Source

twitchfy/packages/eventsub/src/logger/Logger.ts:78

noColor()

1
static noColor(msg: string): string

A function that returns the input string as is, without any color modification.

Parameters

Parameter	Type	Description
`msg`	`string`	The message to log.

Returns

string

The input message as is.

Source

twitchfy/packages/eventsub/src/logger/Logger.ts:248