Class: Logger

Constructors

constructor

+ new Logger(options?: LoggerConstructorOptions): Logger

Creates a new Logger instance

example

const logger = new Logger({ logsPath: __dirname + "/logs.json" });

Parameters:

Name	Type
options?	LoggerConstructorOptions

Returns: Logger

Defined in: index.ts:165

Properties

COLORS

▪ Readonly Static COLORS: object

ANSI Escape Sequences

example

console.log(Logger.COLORS.Dim + "Dim log" + Logger.COLORS.Reset);

Type declaration:

Name	Type
BgBlack	string
BgBlue	string
BgCyan	string
BgGreen	string
BgMagenta	string
BgRed	string
BgWhite	string
BgYellow	string
Blink	string
Bright	string
Dim	string
FgBlack	string
FgBlue	string
FgCyan	string
FgGreen	string
FgMagenta	string
FgRed	string
FgWhite	string
FgYellow	string
Hidden	string
Reset	string
Reverse	string
Underscore	string

Defined in: index.ts:152

Accessors

logs

• get logs(): Log[]

All logs that have been output by this Logger instance

example

const logs = logger.logs;

Returns: Log[]

Defined in: index.ts:191

---

logsPath

• get logsPath(): undefined | string

The output file path

example

const logsPath = logger.logsPath;

Returns: undefined | string

Defined in: index.ts:204

• set logsPath(logsPath: undefined | string): void

The output file path

example

logger.logsPath = __dirname + "/logs.json";

Parameters:

Name	Type
logsPath	undefined | string

Returns: void

Defined in: index.ts:217

Methods

error

▸ error(message: unknown): Promise<Log>

Logs a success message to the console and writes to the output file path

example

await logger.error("Hello");

example

await logger.error(2);

example

await logger.error(["hi!", 4, ["nested string"]]);

Parameters:

Name	Type	Description
message	unknown	The error message to log

Returns: Promise<Log>

Defined in: index.ts:556

▸ error(message: unknown, logOptions: Pick<LogOptionsWithoutWrite, writeToFile>): Log

Logs an error message to the console and DOES NOT write to the output file path

example

await logger.error("Hello", {

writeToFile: false,

});

Parameters:

Name	Type	Description
message	unknown	The error message to log
logOptions	Pick<LogOptionsWithoutWrite, writeToFile>	Logging options

Returns: Log

Defined in: index.ts:570

▸ error(message: unknown, logOptions: Pick<LogOptionsWithWrite, writeToFile | extra>): Promise<Log>

Logs an error message to the console and writes to the output file path

example

await logger.error("Hello", {

writeToFile: true,

});

example

await logger.error(32, {

extra: "this part is not logged"

});

Parameters:

Name	Type	Description
message	unknown	The error message to log
logOptions	Pick<LogOptionsWithWrite, writeToFile | extra>	Logging options

Returns: Promise<Log>

Defined in: index.ts:593

---

info

▸ info(message: unknown): Promise<Log>

Logs a success message to the console and writes to the output file path

example

await logger.info("Hello");

example

await logger.info(2);

example

await logger.info(["hi!", 4, ["nested string"]]);

Parameters:

Name	Type	Description
message	unknown	The info message to log

Returns: Promise<Log>

Defined in: index.ts:410

▸ info(message: unknown, logOptions: Pick<LogOptionsWithoutWrite, writeToFile>): Log

Logs an info message to the console and DOES NOT write to the output file path

example

await logger.info("Hello", {

writeToFile: false,

});

Parameters:

Name	Type	Description
message	unknown	The info message to log
logOptions	Pick<LogOptionsWithoutWrite, writeToFile>	Logging options

Returns: Log

Defined in: index.ts:424

▸ info(message: unknown, logOptions: Pick<LogOptionsWithWrite, writeToFile | extra>): Promise<Log>

Logs an info message to the console and writes to the output file path

example

await logger.info("Hello", {

writeToFile: true,

});

example

await logger.info(32, {

extra: "this part is not logged"

});

Parameters:

Name	Type	Description
message	unknown	The info message to log
logOptions	Pick<LogOptionsWithWrite, writeToFile | extra>	Logging options

Returns: Promise<Log>

Defined in: index.ts:447

---

log

▸ log(message: unknown): Promise<Log>

Logs a message to the console and writes to the output file path

example

await logger.log("Hello");

example

await logger.log(2);

example

await logger.log(["hi!", 4, ["nested string"]]);

Parameters:

Name	Type	Description
message	unknown	The message to log

Returns: Promise<Log>

Defined in: index.ts:239

▸ log(message: unknown, logOptions: LogOptionsWithoutWrite): Log

Logs a message to the console and DOES NOT write to the output file path

example

await logger.log(31, {

writeToFile: false,

});

example

await logger.log("Hello", {

writeToFile: false,

type: "error",

});

Parameters:

Name	Type	Description
message	unknown	The message to log
logOptions	LogOptionsWithoutWrite	Logging options

Returns: Log

Defined in: index.ts:260

▸ log(message: unknown, logOptions: LogOptionsWithWrite): Promise<Log>

Logs a message to the console and writes to the output file path

example

await logger.log("Hello", {

writeToFile: true,

});

example

await logger.log(["hi", "hello"], {

writeToFile: true,

type: "success",

});

example

await logger.log(32, {

type: "info",

extra: "this part is not logged"

});

Parameters:

Name	Type	Description
message	unknown	The message to log
logOptions	LogOptionsWithWrite	Logging options

Returns: Promise<Log>

Defined in: index.ts:288

---

success

▸ success(message: unknown): Promise<Log>

Logs a success message to the console and writes to the output file path

example

await logger.success("Hello");

example

await logger.success(2);

example

await logger.success(["hi!", 4, ["nested string"]]);

Parameters:

Name	Type	Description
message	unknown	The success message to log

Returns: Promise<Log>

Defined in: index.ts:337

▸ success(message: unknown, logOptions: Pick<LogOptionsWithoutWrite, writeToFile>): Log

Logs a success message to the console and DOES NOT write to the output file path

example

await logger.success("Hello", {

writeToFile: false,

});

Parameters:

Name	Type	Description
message	unknown	The success message to log
logOptions	Pick<LogOptionsWithoutWrite, writeToFile>	Logging options

Returns: Log

Defined in: index.ts:351

▸ success(message: unknown, logOptions: Pick<LogOptionsWithWrite, writeToFile | extra>): Promise<Log>

Logs a success message to the console and writes to the output file path

example

await logger.success("Hello", {

writeToFile: true,

});

example

await logger.success(32, {

extra: "this part is not logged"

});

Parameters:

Name	Type	Description
message	unknown	The success message to log
logOptions	Pick<LogOptionsWithWrite, writeToFile | extra>	Logging options

Returns: Promise<Log>

Defined in: index.ts:374

---

warn

▸ warn(message: unknown): Promise<Log>

Logs a success message to the console and writes to the output file path

example

await logger.warn("Hello");

example

await logger.warn(2);

example

await logger.warn(["hi!", 4, ["nested string"]]);

Parameters:

Name	Type	Description
message	unknown	The warn message to log

Returns: Promise<Log>

Defined in: index.ts:483

▸ warn(message: unknown, logOptions: Pick<LogOptionsWithoutWrite, writeToFile>): Log

Logs a warning message to the console and DOES NOT write to the output file path

example

await logger.warn("Hello", {

writeToFile: false,

});

Parameters:

Name	Type	Description
message	unknown	The warning message to log
logOptions	Pick<LogOptionsWithoutWrite, writeToFile>	Logging options

Returns: Log

Defined in: index.ts:497

▸ warn(message: unknown, logOptions: Pick<LogOptionsWithWrite, writeToFile | extra>): Promise<Log>

Logs a warning message to the console and writes to the output file path

example

await logger.warn("Hello", {

writeToFile: true,

});

example

await logger.warn(32, {

extra: "this part is not logged"

});

Parameters:

Name	Type	Description
message	unknown	The warning message to log
logOptions	Pick<LogOptionsWithWrite, writeToFile | extra>	Logging options

Returns: Promise<Log>

Defined in: index.ts:520

---

writeLogs

▸ writeLogs(): Promise<void>

Writes the logs stored in this.logs to the output file

example

await logger.writeLogs();

Returns: Promise<void>

Defined in: index.ts:620

---

bold

▸ Staticbold(message: unknown, afterColored?: string): void

Logs a bold message

example

Logger.bold("BOLD!");

example

Logger.bold("BOLD!", "this part is not bold");

Parameters:

Name	Type	Default value	Description
message	unknown	-	The bold message to log
afterColored	string	""	The optional message after the bold message (on the same line)

Returns: void

Defined in: index.ts:705

---

coloredLog

▸ StaticcoloredLog(color: Reset | Bright | Dim | Underscore | Blink | Reverse | Hidden | FgBlack | FgRed | FgGreen | FgYellow | FgBlue | FgMagenta | FgCyan | FgWhite | BgBlack | BgRed | BgGreen | BgYellow | BgBlue | BgMagenta | BgCyan | BgWhite, message: unknown, afterColored?: string, consoleLevel?: log | warn | error): void

Logs a colored message to the console

example

Logger.coloredLog("BgBlue", "hi");

example

Logger.coloredLog("FgYellow", "hi", "this string will not be colored");

example

Logger.coloredLog("FgRed", "error!!!", "not colored", "error");

Parameters:

Name	Type	Default value	Description
color	Reset | Bright | Dim | Underscore | Blink | Reverse | Hidden | FgBlack | FgRed | FgGreen | FgYellow | FgBlue | FgMagenta | FgCyan | FgWhite | BgBlack | BgRed | BgGreen | BgYellow | BgBlue | BgMagenta | BgCyan | BgWhite	-	The color to log in
message	unknown	-	The message to log
afterColored	string	""	The optional message after the colored message (on the same line)
consoleLevel	log | warn | error	"log"	The console level to use (log, warn, or error)

Returns: void

Defined in: index.ts:679

---

error

▸ Staticerror(message: unknown, afterColored?: string): void

Logs an error message in red

example

Logger.error("ERROR!");

example

Logger.error("ERROR!", "this part is not red");

Parameters:

Name	Type	Default value	Description
message	unknown	-	The error message to log
afterColored	string	""	The optional message after the error message (on the same line)

Returns: void

Defined in: index.ts:781

---

info

▸ Staticinfo(message: unknown, afterColored?: string): void

Logs an info message in blue

example

Logger.info("information...");

example

Logger.info("information...", "this part is not blue");

Parameters:

Name	Type	Default value	Description
message	unknown	-	The info message to log
afterColored	string	""	The optional message after the info message (on the same line)

Returns: void

Defined in: index.ts:743

---

line

▸ Staticline(): void

Logs an empty line to the console

example

Logger.line();

Returns: void

Defined in: index.ts:654

---

log

▸ Staticlog(message?: unknown, ...optionalParams: any[]): void

Logs to the console

example

Logger.log("hi");

example

Logger.log("hi %s", "Bill");

Parameters:

Name	Type	Description
message?	unknown	The message to log
...optionalParams	any[]	Substitution strings

Returns: void

Defined in: index.ts:641

---

success

▸ Staticsuccess(message: unknown, afterColored?: string): void

Logs a success message in green

example

Logger.success("SUCCESS!");

example

Logger.success("SUCCESS!", "this part is not green");

Parameters:

Name	Type	Default value	Description
message	unknown	-	The success message to log
afterColored	string	""	The optional message after the success message (on the same line)

Returns: void

Defined in: index.ts:724

---

warn

▸ Staticwarn(message: unknown, afterColored?: string): void

Logs a warning message in yellow

example

Logger.warn("WARNING!");

example

Logger.warn("WARNING!", "this part is not yellow");

Parameters:

Name	Type	Default value	Description
message	unknown	-	The warning message to log
afterColored	string	""	The optional message after the warning message (on the same line)

Returns: void

Defined in: index.ts:762