@tscommon/logger

Interface ILogger

Source
interface ILogger {
    alert(message: string, payload?: LogPayload): void;
    critical(message: string, payload?: LogPayload): void;
    debug(message: string, payload?: LogPayload): void;
    default(message: string, payload?: LogPayload): void;
    emergency(message: string, payload?: LogPayload): void;
    error(message: string, payload?: LogPayload): void;
    info(message: string, payload?: LogPayload): void;
    notice(message: string, payload?: LogPayload): void;
    warning(message: string, payload?: LogPayload): void;
}

Methods§

Source§

alert(message: string, payload?: LogPayload): void

A person must take an action immediately.

Example:

Logger.alert('An error occurred.', { status: 500, error: new Error('Something went wrong.') });
Source§

critical(message: string, payload?: LogPayload): void

Critical events cause more severe problems or outages.

Example:

Logger.critical('An error occurred.', { status: 500, error: new Error('Something went wrong.') });
Source§

debug(message: string, payload?: LogPayload): void

Debug or trace information.

Example:

Logger.debug('The server is running.');
Logger.debug('The server is running.', { port: 3000 });
Source§

default(message: string, payload?: LogPayload): void

The log entry has no assigned severity level.

Example:

Logger.default('The server is running.');
Logger.default('The server is running.', { port: 3000 });
Source§

emergency(message: string, payload?: LogPayload): void

One or more systems are unusable.

Example:

Logger.emergency('An error occurred.', { status: 500, error: new Error('Something went wrong.') });
Source§

error(message: string, payload?: LogPayload): void

Error events are likely to cause problems.

Example:

Logger.error('An error occurred.', { status: 500, error: new Error('Something went wrong.') });
Source§

info(message: string, payload?: LogPayload): void

Routine information, such as ongoing status or performance.

Example:

Logger.info('The server is running.');
Logger.info('The server is running.', { port: 3000 });
Source§

notice(message: string, payload?: LogPayload): void

Normal but significant events, such as start up, shut down, or a configuration change.

Example:

Logger.notice('The server is running.');
Logger.notice('The server is running.', { port: 3000 });
Source§

warning(message: string, payload?: LogPayload): void

Warning events might cause problems.

Example:

Logger.warning('Unauthorized access.', { status: 401 });