Class: Logger
logger/src.Logger
The logger class.
since 1.0.0
Hierarchy
Logger↳
Logger
Constructors
constructor
• new Logger(options?)
Parameters
| Name | Type |
|---|---|
options | LoggerOptions |
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/index.d.ts:2566
levels
▪ Static Protected Readonly levels: Map<LogLevel, LogMethods>
Inherited from
BuiltinLogger.levels
Defined in
node_modules/@sapphire/framework/dist/index.d.ts:2576
Accessors
levels
• Private get levels(): Map<LogLevel, LogMethods>
Returns
Map<LogLevel, LogMethods>
Defined in
projects/plugins/packages/logger/src/lib/Logger.ts:69
stylize
• Static get stylize(): boolean
Gets whether or not colorette is enabled.
since 1.0.0
Returns
boolean
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/index.d.ts:2570
error
▸ error(...values): void
Parameters
| Name | Type |
|---|---|
...values | readonly unknown[] |
Returns
void
Inherited from
BuiltinLogger.error
Defined in
node_modules/@sapphire/framework/dist/index.d.ts:2573
fatal
▸ fatal(...values): void
Parameters
| Name | Type |
|---|---|
...values | readonly unknown[] |
Returns
void
Inherited from
BuiltinLogger.fatal
Defined in
node_modules/@sapphire/framework/dist/index.d.ts:2574
has
▸ has(level): boolean
Parameters
| Name | Type |
|---|---|
level | LogLevel |
Returns
boolean
Inherited from
BuiltinLogger.has
Defined in
node_modules/@sapphire/framework/dist/index.d.ts:2568
info
▸ info(...values): void
Parameters
| Name | Type |
|---|---|
...values | readonly unknown[] |
Returns
void
Inherited from
BuiltinLogger.info
Defined in
node_modules/@sapphire/framework/dist/index.d.ts:2571
preprocess
▸ Protected preprocess(values): string
Pre-processes an array of values.
since 1.0.0
Parameters
| Name | Type | Description |
|---|---|---|
values | readonly unknown[] | The values to pre-process. |
Returns
string
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/index.d.ts:2569
warn
▸ warn(...values): void
Parameters
| Name | Type |
|---|---|
...values | readonly unknown[] |
Returns
void
Inherited from
BuiltinLogger.warn
Defined in
node_modules/@sapphire/framework/dist/index.d.ts:2572
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
▸ Static Private 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
▸ Static Private ensureDefaultLevel(options, defaults, color, name): LoggerLevel
Parameters
| Name | Type |
|---|---|
options | undefined | LoggerLevelOptions |
defaults | LoggerLevelOptions |
color | Color |
name | string |