winston

winston

Version 3.17.0
Published 5 months ago
271 kB
11 dependencies
MIT license

Install

npm i winston

yarn add winston

pnpm add winston

Overview

A logger for just about everything.

Index

Variables

debug
error
exceptions
exitOnError
http
info
level
log
loggers
rejections
silly
verbose
version
warn

Functions

add()
addColors()
child()
clear()
configure()
createLogger()
profile()
query()
remove()
startTimer()
stream()

Variables

variable debug

let debug: LeveledLogMethod;

variable error

let error: LeveledLogMethod;

variable exceptions

let exceptions: ExceptionHandler;

variable exitOnError

let exitOnError: boolean | Function;

variable http

let http: LeveledLogMethod;

variable info

let info: LeveledLogMethod;

variable level

let level: string;

variable log

let log: LogMethod;

variable loggers

let loggers: Container;

variable rejections

let rejections: RejectionHandler;

variable silly

let silly: LeveledLogMethod;

variable verbose

let verbose: LeveledLogMethod;

variable version

let version: string;

variable warn

let warn: LeveledLogMethod;

Functions

function add

add: (transport: Transport) => Logger;

function addColors

addColors: (target: Config.AbstractConfigSetColors) => any;

function child

child: (options: Object) => Logger;

function clear

clear: () => Logger;

function configure

configure: (options: LoggerOptions) => void;

function createLogger

createLogger: (options?: LoggerOptions) => Logger;

function profile

profile: (id: string | number) => Logger;

function query

query: (
    options?: QueryOptions,
    callback?: (err: Error, results: any) => void
) => any;

function remove

remove: (transport: Transport) => Logger;

function startTimer

startTimer: () => Profiler;

function stream

stream: (options?: any) => NodeJS.ReadableStream;

Classes

class Container

class Container {}

constructor

constructor(options?: LoggerOptions);

property loggers

loggers: Map<string, Logger>;

property options

options: LoggerOptions;

method add

add: (id: string, options?: LoggerOptions) => Logger;

method close

close: (id?: string) => void;

method get

get: (id: string, options?: LoggerOptions) => Logger;

method has

has: (id: string) => boolean;

class ExceptionHandler

class ExceptionHandler {}

constructor

constructor(logger: Logger);

property catcher

catcher: boolean | Function;

property handlers

handlers: Map<any, any>;

property logger

logger: Logger;

method getAllInfo

getAllInfo: (err: string | Error) => object;

method getOsInfo

getOsInfo: () => object;

method getProcessInfo

getProcessInfo: () => object;

method getTrace

getTrace: (err: Error) => object;

method handle

handle: (...transports: Transport[]) => void;

method unhandle

unhandle: (...transports: Transport[]) => void;

class Logger

class Logger extends NodeJSStream.Transform {}

constructor

constructor(options?: LoggerOptions);

property alert

alert: LeveledLogMethod;

property crit

crit: LeveledLogMethod;

property data

data: LeveledLogMethod;

property debug

debug: LeveledLogMethod;

property defaultMeta

defaultMeta?: any;

property emerg

emerg: LeveledLogMethod;

property error

error: LeveledLogMethod;

property exceptions

exceptions: ExceptionHandler;

property exitOnError

exitOnError: boolean | Function;

property format

format: logform.Format;

property help

help: LeveledLogMethod;

property http

http: LeveledLogMethod;

property info

info: LeveledLogMethod;

property input

input: LeveledLogMethod;

property level

level: string;

property levels

levels: config.AbstractConfigSetLevels;

property log

log: LogMethod;

property notice

notice: LeveledLogMethod;

property profilers

profilers: {};

property prompt

prompt: LeveledLogMethod;

property rejections

rejections: RejectionHandler;

property silent

silent: boolean;

property silly

silly: LeveledLogMethod;

property transports

transports: Transport[];

property verbose

verbose: LeveledLogMethod;

property warn

warn: LeveledLogMethod;

property warning

warning: LeveledLogMethod;

method add

add: (transport: Transport) => this;

method child

child: (options: Object) => this;

method clear

clear: () => this;

method close

close: () => this;

method configure

configure: (options: LoggerOptions) => void;

method isDebugEnabled

isDebugEnabled: () => boolean;

method isErrorEnabled

isErrorEnabled: () => boolean;

method isInfoEnabled

isInfoEnabled: () => boolean;

method isLevelEnabled

isLevelEnabled: (level: string) => boolean;

method isSillyEnabled

isSillyEnabled: () => boolean;

method isVerboseEnabled

isVerboseEnabled: () => boolean;

method isWarnEnabled

isWarnEnabled: () => boolean;

method profile

profile: (id: string | number, meta?: Record<string, any>) => this;

method query

query: (
    options?: QueryOptions,
    callback?: (err: Error, results: any) => void
) => any;

method remove

remove: (transport: Transport) => this;

method startTimer

startTimer: () => Profiler;

method stream

stream: (options?: any) => NodeJS.ReadableStream;

class Profiler

class Profiler {}

property logger

logger: Logger;

property start

start: number;

method done

done: (info?: any) => boolean;

class RejectionHandler

class RejectionHandler {}

constructor

constructor(logger: Logger);

property catcher

catcher: boolean | Function;

property handlers

handlers: Map<any, any>;

property logger

logger: Logger;

method getAllInfo

getAllInfo: (err: string | Error) => object;

method getOsInfo

getOsInfo: () => object;

method getProcessInfo

getProcessInfo: () => object;

method getTrace

getTrace: (err: Error) => object;

method handle

handle: (...transports: Transport[]) => void;

method unhandle

unhandle: (...transports: Transport[]) => void;

Interfaces

interface LeveledLogMethod

interface LeveledLogMethod {}

call signature

(message: string, ...meta: any[]): Logger;

call signature

(message: any): Logger;

call signature

(infoObject: object): Logger;

interface LogEntry

interface LogEntry {}

property level

level: string;

property message

message: string;

index signature

[optionName: string]: any;

interface LoggerOptions

interface LoggerOptions {}

property defaultMeta

defaultMeta?: any;

property exceptionHandlers

exceptionHandlers?: any;

property exitOnError

exitOnError?: Function | boolean;

property format

format?: logform.Format;

property handleExceptions

handleExceptions?: boolean;

property handleRejections

handleRejections?: boolean;

property level

level?: string;

property levels

levels?: Config.AbstractConfigSetLevels;

property rejectionHandlers

rejectionHandlers?: any;

property silent

silent?: boolean;

property transports

transports?: Transport[] | Transport;

interface LogMethod

interface LogMethod {}

call signature

(level: string, message: string, ...meta: any[]): Logger;

call signature

(entry: LogEntry): Logger;

call signature

(level: string, message: any): Logger;

interface QueryOptions

interface QueryOptions {}

property fields

fields: any;

property from

from?: Date;

property limit

limit?: number;

property order

order?: 'asc' | 'desc';

property rows

rows?: number;

property start

start?: number;

property until

until?: Date;

Package Files (1)

index.d.ts

Dependencies (11)

Dev Dependencies (17)

Peer Dependencies (0)

No peer dependencies.

Badge

To add a badge like this oneto your package's README, use the codes available below.

You may also use Shields.io to create a custom badge linking to https://www.jsdocs.io/package/winston.

Markdown

[![jsDocs.io](https://img.shields.io/badge/jsDocs.io-reference-blue)](https://www.jsdocs.io/package/winston)

HTML

<a href="https://www.jsdocs.io/package/winston"><img src="https://img.shields.io/badge/jsDocs.io-reference-blue" alt="jsDocs.io"></a>

Updated 5 months ago.
Package analyzed in 3473 ms.
Missing or incorrect documentation? Open an issue for this package.