Class: Logger

@sapphire/plugin-logger.Logger

The logger class.

Since

1.0.0

Hierarchy

• Logger

  ↳ Logger

Constructors

constructor

• new Logger(options?): Logger

Parameters

Name	Type
options	LoggerOptions

Returns

Logger

Overrides

BuiltinLogger.constructor

Defined in

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

Properties

console

• Readonly console: Console

The console this writes to.

Since

1.0.0

Defined in

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

---

depth

• Readonly depth: number

The inspect depth when logging objects.

Since

1.0.0

Defined in

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

---

formats

• Readonly formats: Map<LogLevel, LoggerLevel>

The formats supported by the logger.

Since

1.0.0

Defined in

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

---

join

• Readonly join: string

The string write will join values by.

Since

1.0.0

Defined in

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

---

level

• level: LogLevel

Inherited from

BuiltinLogger.level

Defined in

node_modules/@sapphire/framework/dist/esm/index.d.mts:3711

---

levels

▪ Protected Static Readonly levels: Map<LogLevel, LogMethods>

Inherited from

BuiltinLogger.levels

Defined in

node_modules/@sapphire/framework/dist/esm/index.d.mts:3721

Accessors

levels

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

Returns

Map<LogLevel, LogMethods>

Defined in

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

---

stylize

• get stylize(): boolean

Gets whether or not colorette is enabled.

Returns

boolean

Since

1.0.0

Defined in

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

Methods

debug

▸ debug(...values): void

Parameters

Name	Type
...values	readonly unknown[]

Returns

void

Inherited from

BuiltinLogger.debug

Defined in

node_modules/@sapphire/framework/dist/esm/index.d.mts:3715

---

error

▸ error(...values): void

Parameters

Name	Type
...values	readonly unknown[]

Returns

void

Inherited from

BuiltinLogger.error

Defined in

node_modules/@sapphire/framework/dist/esm/index.d.mts:3718

---

fatal

▸ fatal(...values): void

Parameters

Name	Type
...values	readonly unknown[]

Returns

void

Inherited from

BuiltinLogger.fatal

Defined in

node_modules/@sapphire/framework/dist/esm/index.d.mts:3719

---

has

▸ has(level): boolean

Parameters

Name	Type
level	LogLevel

Returns

boolean

Inherited from

BuiltinLogger.has

Defined in

node_modules/@sapphire/framework/dist/esm/index.d.mts:3713

---

info

▸ info(...values): void

Parameters

Name	Type
...values	readonly unknown[]

Returns

void

Inherited from

BuiltinLogger.info

Defined in

node_modules/@sapphire/framework/dist/esm/index.d.mts:3716

---

preprocess

▸ preprocess(values): string

Pre-processes an array of values.

Parameters

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

Returns

string

Since

1.0.0

Defined in

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

---

trace

▸ trace(...values): void

Parameters

Name	Type
...values	readonly unknown[]

Returns

void

Inherited from

BuiltinLogger.trace

Defined in

node_modules/@sapphire/framework/dist/esm/index.d.mts:3714

---

warn

▸ warn(...values): void

Parameters

Name	Type
...values	readonly unknown[]

Returns

void

Inherited from

BuiltinLogger.warn

Defined in

node_modules/@sapphire/framework/dist/esm/index.d.mts:3717

---

write

▸ write(level, ...values): void

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

Parameters

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

Returns

void

Overrides

BuiltinLogger.write

Defined in

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

---

createFormatMap

▸ createFormatMap(options?, defaults?): Map<LogLevel, LoggerLevel>

Parameters

Name	Type
options	LoggerFormatOptions
defaults	LoggerLevelOptions

Returns

Map<LogLevel, LoggerLevel>

Defined in

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

---

ensureDefaultLevel

▸ ensureDefaultLevel(options, defaults, color, name): LoggerLevel

Parameters

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

Returns

LoggerLevel

Defined in

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