@xylabs/logger


XYLabs Logger Library
Reference
@xylabs/logger
Classes
Interfaces
Type Aliases
Variables
Functions
classes
ConsoleLogger
@xylabs/logger
Interface to handle overlap between Winston &
console with as much congruency as possible.
Extends
Constructors
Constructor
new ConsoleLogger(level): ConsoleLogger;
Parameters
level
LogLevelValue = LogLevel.warn
Returns
ConsoleLogger
Overrides
LevelLogger.constructor
Properties
level
readonly level: LogLevelValue;
Inherited from
LevelLogger.level
logger
readonly logger: Logger;
Inherited from
LevelLogger.logger
Accessors
debug
Get Signature
get debug(): LogFunction;
Returns
LogFunction
Inherited from
LevelLogger.debug
error
Get Signature
get error(): LogFunction;
Returns
LogFunction
Inherited from
LevelLogger.error
info
Get Signature
get info(): LogFunction;
Returns
LogFunction
Inherited from
LevelLogger.info
log
Get Signature
get log(): LogFunction;
Returns
LogFunction
Inherited from
LevelLogger.log
trace
Get Signature
get trace(): LogFunction;
Returns
LogFunction
Inherited from
LevelLogger.trace
warn
Get Signature
get warn(): LogFunction;
Returns
LogFunction
Inherited from
LevelLogger.warn
IdLogger
@xylabs/logger
Interface to handle overlap between Winston &
console with as much congruency as possible.
Implements
Constructors
Constructor
new IdLogger(logger, id?): IdLogger;
Parameters
logger
Logger
id?
() => string
Returns
IdLogger
Accessors
id
Set Signature
set id(id): void;
Parameters
id
string
Returns
void
Methods
debug()
debug(...data): void;
Parameters
data
...unknown[]
Returns
void
Implementation of
Logger.debug
error()
error(...data): void;
Parameters
data
...unknown[]
Returns
void
Implementation of
Logger.error
info()
info(...data): void;
Parameters
data
...unknown[]
Returns
void
Implementation of
Logger.info
log()
log(...data): void;
Parameters
data
...unknown[]
Returns
void
Implementation of
Logger.log
trace()
trace(...data): void;
Parameters
data
...unknown[]
Returns
void
Implementation of
Logger.trace
warn()
warn(...data): void;
Parameters
data
...unknown[]
Returns
void
Implementation of
Logger.warn
LevelLogger
@xylabs/logger
Interface to handle overlap between Winston &
console with as much congruency as possible.
Extended by
Implements
Constructors
Constructor
new LevelLogger(logger, level): LevelLogger;
Parameters
logger
Logger
level
LogLevelValue = LogLevel.warn
Returns
LevelLogger
Properties
level
readonly level: LogLevelValue;
logger
readonly logger: Logger;
Accessors
debug
Get Signature
get debug(): LogFunction;
Returns
LogFunction
Implementation of
Logger.debug
error
Get Signature
get error(): LogFunction;
Returns
LogFunction
Implementation of
Logger.error
info
Get Signature
get info(): LogFunction;
Returns
LogFunction
Implementation of
Logger.info
log
Get Signature
get log(): LogFunction;
Returns
LogFunction
Implementation of
Logger.log
trace
Get Signature
get trace(): LogFunction;
Returns
LogFunction
Implementation of
Logger.trace
warn
Get Signature
get warn(): LogFunction;
Returns
LogFunction
Implementation of
Logger.warn
SilentLogger
@xylabs/logger
A logger that does not log anything.
This is useful when you want to disable logging
like when running unit tests or in silent mode.
It implements the Logger interface but all methods
are no-op functions.
Implements
Constructors
Constructor
new SilentLogger(): SilentLogger;
Returns
SilentLogger
Properties
debug()
readonly debug: (..._data) => undefined = NoOpLogFunction;
Parameters
_data
...unknown[]
Returns
undefined
Implementation of
Logger.debug
error()
readonly error: (..._data) => undefined = NoOpLogFunction;
Parameters
_data
...unknown[]
Returns
undefined
Implementation of
Logger.error
info()
readonly info: (..._data) => undefined = NoOpLogFunction;
Parameters
_data
...unknown[]
Returns
undefined
Implementation of
Logger.info
log()
readonly log: (..._data) => undefined = NoOpLogFunction;
Parameters
_data
...unknown[]
Returns
undefined
Implementation of
Logger.log
trace()
readonly trace: (..._data) => undefined = NoOpLogFunction;
Parameters
_data
...unknown[]
Returns
undefined
Implementation of
Logger.trace
warn()
readonly warn: (..._data) => undefined = NoOpLogFunction;
Parameters
_data
...unknown[]
Returns
undefined
Implementation of
Logger.warn
functions
NoOpLogFunction
@xylabs/logger
function NoOpLogFunction(..._data): undefined;
Parameters
_data
...unknown[]
Returns
undefined
getFunctionName
@xylabs/logger
function getFunctionName(depth): string;
Parameters
depth
number = 2
Returns
string
interfaces
Logger
@xylabs/logger
Interface to handle overlap between Winston &
console with as much congruency as possible.
Properties
debug
debug: LogFunction;
error
error: LogFunction;
info
info: LogFunction;
log
log: LogFunction;
trace
trace: LogFunction;
warn
warn: LogFunction;
type-aliases
LogFunction
@xylabs/logger
type LogFunction = (...data) => void;
Parameters
data
...unknown[]
Returns
void
LogLevel
@xylabs/logger
type LogLevel = LogLevelValue;
Deprecated
Use LogLevelValue instead.
This name conflicts with the LogLevel enum and
makes it confusing to import
LogLevelKey
@xylabs/logger
type LogLevelKey = EnumKey<typeof LogLevel>;
LogLevelValue
@xylabs/logger
type LogLevelValue = EnumValue<typeof LogLevel>;
LogVerbosity
@xylabs/logger
type LogVerbosity = LogLevelKey;
variables
LogLevel
@xylabs/logger
const LogLevel: Enum<{
error: 1;
warn: 2;
info: 3;
log: 4;
debug: 5;
trace: 6;
}>;
Part of sdk-js
Maintainers
License
See the LICENSE file for license details
Credits
Made with 🔥 and ❄️ by XYLabs