import Logger from 'pop-api/src/middleware/Logger.js'

public class | source

Logger

Class for setting up the logger.

Test:

Logger

Static Member Summary

Static Public Members
public static	fileTransport: Object The file transport for the logger.

Constructor Summary

Public Constructor
public	constructor(PopApi: PopApi, options: Object) Create a new Logger object.

Member Summary

Public Members
public	levels: Object The log levels the logger middleware will be using.
public	logDir: string The directory where the log file will be stored.
public	name: string The name of the log file.

Method Summary

Public Methods
public	consoleFormatter(): Object Formatter method which formats the output to the console.
public	createHttpLogger(pretty: boolean): ExpressWinston Create a Http logger instance.
public	createLogger(pretty: boolean, quiet: boolean): Object \| Winston Method to create a global logger object based on the properties of the Logger class.
public	createLoggerInstance(suffix: string, pretty: boolean): Winston Create a logger instance.
public	fileFormatter(): Object Formatter method which formats the output to the log file.
public	getConsoleTransport(pretty: boolean): Object Create a Console transport.
public	getFileTransport(file: string): Object Create a File transport.
public	getHttpLoggerMessage(req: Object, res: Object): string Get the log message for Http logger.
public	getLevelColor(level: string): string Get the color of the output based on the log level.
public	getLogger(type: string, pretty: boolean, quiet: boolean): Middleware \| Winston \| undefined Get a logger object based on the choice.
public	prettyPrintConsole(info: Object): Object Update the message property and add the splat property to the info object for interpolation.

Private Methods
private	_getMessage(info: Object): string Get the message string from the info object.

Static Public Members

public static fileTransport: Object source

The file transport for the logger.

Public Constructors

public constructor(PopApi: PopApi, options: Object) source

Create a new Logger object.

Params:

Name	Type	Attribute	Description
PopApi	PopApi	nullable: false	The PopApi instance to bind the logger to.
options	Object	nullable: false	The options for the logger.
options.name	string	nullable: false	The name of the log file.
options.pretty	boolean	optional nullable: true	Pretty mode for output with colors.
options.quiet	boolean	optional nullable: true	No output.

Throw:

TypeError

'name' and 'logDir' are required options for the Logger middleware!

Test:

Public Members

public levels: Object source

The log levels the logger middleware will be using.

public logDir: string source

The directory where the log file will be stored.

public name: string source

The name of the log file.

Public Methods

public consoleFormatter(): Object source

Formatter method which formats the output to the console.

Return:

Object

The formatter for the console transport.

Test:

Logger should make the console formatter

public createHttpLogger(pretty: boolean): ExpressWinston source

Create a Http logger instance.

Params:

Name	Type	Attribute	Description
pretty	boolean	optional nullable: true	Pretty mode for output with colors.

Return:

ExpressWinston

A configured Http logger instance.

Test:

public createLogger(pretty: boolean, quiet: boolean): Object | Winston source

Method to create a global logger object based on the properties of the Logger class.

Params:

Name	Type	Attribute	Description
pretty	boolean	optional nullable: true	Pretty mode for output with colors.
quiet	boolean	optional nullable: true	No output.

Return:

Object | Winston

A configured logger.

Test:

Logger should create the global logger object

public createLoggerInstance(suffix: string, pretty: boolean): Winston source

Create a logger instance.

Params:

Name	Type	Attribute	Description
suffix	string	nullable: false	The suffix for the log file.
pretty	boolean	optional nullable: true	Pretty mode for output with colors.

Return:

Winston

A configured logger instance.

Test:

public fileFormatter(): Object source

Formatter method which formats the output to the log file.

Return:

Object

The formatter for the file transport.

Test:

Logger should make the file formatter

public getConsoleTransport(pretty: boolean): Object source

Create a Console transport.

Params:

Name	Type	Attribute	Description
pretty	boolean	optional nullable: true	Pretty mode for output with colors.

Return:

Object

A configured Console transport.

Test:

Logger should get a configured winston console transport

public getFileTransport(file: string): Object source

Create a File transport.

Params:

Name	Type	Attribute	Description
file	string	nullable: false	The file to log the output to.

Return:

Object

A configured File transport.

Test:

Logger should get a configured winston file transport

public getHttpLoggerMessage(req: Object, res: Object): string source

Get the log message for Http logger.

Params:

Name	Type	Attribute	Description
req	Object	nullable: false	The request object to log.
res	Object	nullable: false	The response object to log.

Return:

string

The HtpP log message to print.

Test:

Logger should get the message to print for express-winston

public getLevelColor(level: string): string source

Get the color of the output based on the log level.

Params:

Name	Type	Attribute	Description
level	string	optional default: info nullable: true	The log level.

Return:

string

A color based on the log level.

Test:

Logger should test if the correct logger colors are returned

public getLogger(type: string, pretty: boolean, quiet: boolean): Middleware | Winston | undefined source

Get a logger object based on the choice.

Params:

Name	Type	Attribute	Description
type	string	optional nullable: true	The choice for the logger object.
pretty	boolean	optional nullable: true	Pretty mode for output with colors.
quiet	boolean	optional nullable: true	No output.