Class: Logger

Defined in: projects/plugins/packages/logger/src/lib/Logger.ts:11

The logger class.

Since

1.0.0

Extends

• Logger

Constructors

new Logger()

new Logger(options: LoggerOptions): Logger

Defined in: projects/plugins/packages/logger/src/lib/Logger.ts:36

Parameters

Parameter	Type
options	LoggerOptions

Returns

Logger

Overrides

BuiltinLogger.constructor

Properties

console

readonly console: Console

Defined in: projects/plugins/packages/logger/src/lib/Logger.ts:16

The console this writes to.

Since

1.0.0

---

depth

readonly depth: number

Defined in: projects/plugins/packages/logger/src/lib/Logger.ts:34

The inspect depth when logging objects.

Since

1.0.0

---

formats

readonly formats: Map<LogLevel, LoggerLevel>

Defined in: projects/plugins/packages/logger/src/lib/Logger.ts:22

The formats supported by the logger.

Since

1.0.0

---

join

readonly join: string

Defined in: projects/plugins/packages/logger/src/lib/Logger.ts:28

The string write will join values by.

Since

1.0.0

---

level

level: LogLevel

Defined in: node_modules/@sapphire/framework/dist/esm/index.d.mts:3720

Inherited from

BuiltinLogger.level

---

levels

protected readonly static levels: Map<LogLevel, LogMethods>

Defined in: node_modules/@sapphire/framework/dist/esm/index.d.mts:3730

Inherited from

BuiltinLogger.levels

Accessors

levels

Get Signature

get private levels(): Map<LogLevel, LogMethods>

Defined in: projects/plugins/packages/logger/src/lib/Logger.ts:69

Returns

Map<LogLevel, LogMethods>

---

stylize

Get Signature

get static stylize(): boolean

Defined in: projects/plugins/packages/logger/src/lib/Logger.ts:77

Gets whether or not colorette is enabled.

Since

1.0.0

Returns

boolean

Methods

debug()

debug(...values: readonly unknown[]): void

Defined in: node_modules/@sapphire/framework/dist/esm/index.d.mts:3724

Alias of ILogger.write with LogLevel.Debug as level.

Parameters

Parameter	Type	Description
...values	readonly unknown[]	The values to log.

Returns

void

Inherited from

BuiltinLogger.debug

---

error()

error(...values: readonly unknown[]): void

Defined in: node_modules/@sapphire/framework/dist/esm/index.d.mts:3727

Alias of ILogger.write with LogLevel.Error as level.

Parameters

Parameter	Type	Description
...values	readonly unknown[]	The values to log.

Returns

void

Inherited from

BuiltinLogger.error

---

fatal()

fatal(...values: readonly unknown[]): void

Defined in: node_modules/@sapphire/framework/dist/esm/index.d.mts:3728

Alias of ILogger.write with LogLevel.Fatal as level.

Parameters

Parameter	Type	Description
...values	readonly unknown[]	The values to log.

Returns

void

Inherited from

BuiltinLogger.fatal

---

has()

has(level: LogLevel): boolean

Defined in: node_modules/@sapphire/framework/dist/esm/index.d.mts:3722

Checks whether a level is supported.

Parameters

Parameter	Type	Description
level	LogLevel	The level to check.

Returns

boolean

Inherited from

BuiltinLogger.has

---

info()

info(...values: readonly unknown[]): void

Defined in: node_modules/@sapphire/framework/dist/esm/index.d.mts:3725

Alias of ILogger.write with LogLevel.Info as level.

Parameters

Parameter	Type	Description
...values	readonly unknown[]	The values to log.

Returns

void

Inherited from

BuiltinLogger.info

---

preprocess()

protected preprocess(values: readonly unknown[]): string

Defined in: projects/plugins/packages/logger/src/lib/Logger.ts:64

Pre-processes an array of values.

Parameters

Parameter	Type	Description
values	readonly unknown[]	The values to pre-process.

Returns

string

Since

1.0.0

---

trace()

trace(...values: readonly unknown[]): void

Defined in: node_modules/@sapphire/framework/dist/esm/index.d.mts:3723

Alias of ILogger.write with LogLevel.Trace as level.

Parameters

Parameter	Type	Description
...values	readonly unknown[]	The values to log.

Returns

void

Inherited from

BuiltinLogger.trace

---

warn()

warn(...values: readonly unknown[]): void

Defined in: node_modules/@sapphire/framework/dist/esm/index.d.mts:3726

Alias of ILogger.write with LogLevel.Warn as level.

Parameters

Parameter	Type	Description
...values	readonly unknown[]	The values to log.

Returns

void

Inherited from

BuiltinLogger.warn

---

write()

write(level: LogLevel, ...values: readonly unknown[]): void

Defined in: projects/plugins/packages/logger/src/lib/Logger.ts:50

Writes the log message given a level and the value(s).

Parameters

Parameter	Type	Description
level	LogLevel	The log level.
...values	readonly unknown[]	The values to log.

Returns

void

Overrides

BuiltinLogger.write

---

createFormatMap()

private static createFormatMap(options: LoggerFormatOptions, defaults: LoggerLevelOptions): Map<LogLevel, LoggerLevel>

Defined in: projects/plugins/packages/logger/src/lib/Logger.ts:81

Parameters

Parameter	Type
options	LoggerFormatOptions
defaults	LoggerLevelOptions

Returns

Map<LogLevel, LoggerLevel>

---

ensureDefaultLevel()

private static ensureDefaultLevel(options: undefined | LoggerLevelOptions, defaults: LoggerLevelOptions, color: Color, name: string): LoggerLevel

Defined in: projects/plugins/packages/logger/src/lib/Logger.ts:93

Parameters

Parameter	Type
options	undefined | LoggerLevelOptions
defaults	LoggerLevelOptions
color	Color
name	string

Returns

LoggerLevel