Logger
TSCord includes a logger service that lets you efficiently log things towards different "locations" in a formatted way.
Configuration
To configure what should be logged and where, head over to this part of the documentation.
Usage
Log
The log()
method of the Logger
service is a little abstraction of the per location methods (listed just below) that will act as a shortcut to log to the console, and optionally to a file or a discord channel depending on params.
Params
Name | Type | Default | Description |
---|---|---|---|
message | string | The message to log | |
level | string | info | info | warn | error |
saveToFile | boolean | true | If the message should be saved in a file |
channelId | string | null | null | Discord channel to log to (if null , nothing will be logged to Discord) |
Usage
import { Logger } from '@services'
const logger = container.resolve(Logger)
logger.log('hello world!')
Per location methods
- Console
- File
- Discord
Log a message in the console using the console()
method.
Params
Name | Type | Default | Description |
---|---|---|---|
message | string | The message to log | |
level | string | info | info | warn | error |
ignoreTemplate | boolean | false | If it should ignore the default timestamp-based template |
Usage
import { Logger } from '@services'
const logger = container.resolve(Logger)
logger.console('hello world!')
Log a message in a log file using the file()
method.
Params
Name | Type | Default | Description |
---|---|---|---|
message | string | The message to log | |
level | string | info | info | warn | error |
Usage
import { Logger } from '@services'
const logger = container.resolve(Logger)
logger.file('Hello world!', 'error') // -> will log it in {logFilesPath}/error.log
Log a message in a Discord channel with embeds using the discord()
method.
Params
Name | Type | Default | Description |
---|---|---|---|
channelId | string | The ID of the discord channel to log to | |
message | string | MessageOptions | Either the message to log or directly an embed or anything that can be sent to discord | |
level | string | info | info | warn | error |
Usage
import { Logger } from '@services'
const logger = container.resolve(Logger)
logger.discord('716641518714355722', 'Hello world!', 'error')