@xylabs/logger

[![logo][]](https://xylabs.com)

[![main-build][]][main-build-link]
[![npm-badge][]][npm-link]
[![npm-downloads-badge][]][npm-link]
[![jsdelivr-badge][]][jsdelivr-link]
[![npm-license-badge][]](LICENSE)
[![codacy-badge][]][codacy-link]
[![codeclimate-badge][]][codeclimate-link]
[![snyk-badge][]][snyk-link]
[![socket-badge][]][socket-link]

XYLabs Logger Library

Reference

@xylabs/logger

*

Classes

- ConsoleLogger
- IdLogger
- LevelLogger
- SilentLogger

Interfaces

- Logger

Type Aliases

- LogFunction
- ~~LogLevel~~
- LogLevelKey
- LogVerbosity
- LogLevelValue

Variables

- LogLevel

Functions

- NoOpLogFunction
- getFunctionName

$3

### ConsoleLogger

@xylabs/logger

*

Interface to handle overlap between Winston &
console with as much congruency as possible.

Extends

- LevelLogger

Constructors

$3

``ts
new ConsoleLogger(level): ConsoleLogger;
`

$3

#### level

LogLevelValue = LogLevel.warn

$3

ConsoleLogger

$3

LevelLogger.constructor

Properties

$3

`ts
readonly level: LogLevelValue;
`

$3

LevelLogger.level

*

$3

`ts
readonly logger: Logger;
`

$3

LevelLogger.logger

Accessors

$3

$3

`ts
get debug(): LogFunction;
`

#### Returns

LogFunction

$3

LevelLogger.debug

*

$3

$3

`ts
get error(): LogFunction;
`

#### Returns

LogFunction

$3

LevelLogger.error

*

$3

$3

`ts
get info(): LogFunction;
`

#### Returns

LogFunction

$3

LevelLogger.info

*

$3

$3

`ts
get log(): LogFunction;
`

#### Returns

LogFunction

$3

LevelLogger.log

*

$3

$3

`ts
get trace(): LogFunction;
`

#### Returns

LogFunction

$3

LevelLogger.trace

*

$3

$3

`ts
get warn(): LogFunction;
`

#### Returns

LogFunction

$3

LevelLogger.warn

### IdLogger

@xylabs/logger

*

Interface to handle overlap between Winston &
console with as much congruency as possible.

Implements

- Logger

Constructors

$3

`ts
new IdLogger(logger, id?): IdLogger;
`

$3

#### logger

Logger

#### id?

() => string

$3

IdLogger

Accessors

$3

$3

`ts
set id(id): void;
`

#### Parameters

##### id

string

#### Returns

void

Methods

$3

`ts
debug(...data): void;
`

$3

#### data

...unknown[]

$3

void

$3

`ts
Logger.debug
`

*

$3

`ts
error(...data): void;
`

$3

#### data

...unknown[]

$3

void

$3

`ts
Logger.error
`

*

$3

`ts
info(...data): void;
`

$3

#### data

...unknown[]

$3

void

$3

`ts
Logger.info
`

*

$3

`ts
log(...data): void;
`

$3

#### data

...unknown[]

$3

void

$3

`ts
Logger.log
`

*

$3

`ts
trace(...data): void;
`

$3

#### data

...unknown[]

$3

void

$3

`ts
Logger.trace
`

*

$3

`ts
warn(...data): void;
`

$3

#### data

...unknown[]

$3

void

$3

`ts
Logger.warn
`

### LevelLogger

@xylabs/logger

*

Interface to handle overlap between Winston &
console with as much congruency as possible.

Extended by

- ConsoleLogger

Implements

- Logger

Constructors

$3

`ts
new LevelLogger(logger, level): LevelLogger;
`

$3

#### logger

Logger

#### level

LogLevelValue = LogLevel.warn

$3

LevelLogger

Properties

$3

`ts
readonly level: LogLevelValue;
`

*

$3

`ts
readonly logger: Logger;
`

Accessors

$3

$3

`ts
get debug(): LogFunction;
`

#### Returns

LogFunction

$3

Logger.debug

*

$3

$3

`ts
get error(): LogFunction;
`

#### Returns

LogFunction

$3

Logger.error

*

$3

$3

`ts
get info(): LogFunction;
`

#### Returns

LogFunction

$3

Logger.info

*

$3

$3

`ts
get log(): LogFunction;
`

#### Returns

LogFunction

$3

Logger.log

*

$3

$3

`ts
get trace(): LogFunction;
`

#### Returns

LogFunction

$3

Logger.trace

*

$3

$3

`ts
get warn(): LogFunction;
`

#### Returns

LogFunction

$3

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

- Logger

Constructors

$3

`ts
new SilentLogger(): SilentLogger;
`

$3

SilentLogger

Properties

$3

`ts
readonly debug: (..._data) => undefined = NoOpLogFunction;
`

$3

#### \_data

...unknown[]

$3

undefined

$3

Logger.debug

*

$3

`ts
readonly error: (..._data) => undefined = NoOpLogFunction;
`

$3

#### \_data

...unknown[]

$3

undefined

$3

Logger.error

*

$3

`ts
readonly info: (..._data) => undefined = NoOpLogFunction;
`

$3

#### \_data

...unknown[]

$3

undefined

$3

Logger.info

*

$3

`ts
readonly log: (..._data) => undefined = NoOpLogFunction;
`

$3

#### \_data

...unknown[]

$3

undefined

$3

Logger.log

*

$3

`ts
readonly trace: (..._data) => undefined = NoOpLogFunction;
`

$3

#### \_data

...unknown[]

$3

undefined

$3

Logger.trace

*

$3

`ts
readonly warn: (..._data) => undefined = NoOpLogFunction;
`

$3

#### \_data

...unknown[]

$3

undefined

$3

Logger.warn

$3

### NoOpLogFunction

@xylabs/logger

*

`ts
function NoOpLogFunction(..._data): undefined;
`

Parameters

$3

...unknown[]

Returns

undefined

### getFunctionName

@xylabs/logger

*

`ts
function getFunctionName(depth): string;
`

Parameters

$3

number = 2

Returns

string

$3

### Logger

@xylabs/logger

*

Interface to handle overlap between Winston &
console with as much congruency as possible.

Properties

$3

`ts
debug: LogFunction;
`

*

$3

`ts
error: LogFunction;
`

*

$3

`ts
info: LogFunction;
`

*

$3

`ts
log: LogFunction;
`

*

$3

`ts
trace: LogFunction;
`

*

$3

`ts
warn: LogFunction;
`

$3

### LogFunction

@xylabs/logger

*

`ts
type LogFunction = (...data) => void;
`

Parameters

$3

...unknown[]

Returns

void

### LogLevel

@xylabs/logger

*

`ts
type LogLevel = LogLevelValue;
`

Deprecated

Use LogLevelValue instead.
This name conflicts with the LogLevel enum and
makes it confusing to import

### LogLevelKey

@xylabs/logger

*

`ts
type LogLevelKey = EnumKey;
`

### LogLevelValue

@xylabs/logger

*

`ts
type LogLevelValue = EnumValue;
`

### LogVerbosity

@xylabs/logger

*

`ts
type LogVerbosity = LogLevelKey;
`

$3

### LogLevel

@xylabs/logger

*

`ts
const LogLevel: Enum<{
error: 1;
warn: 2;
info: 3;
log: 4;
debug: 5;
trace: 6;
}>;
``

Part of sdk-js

Maintainers

- Arie Trouw (arietrouw.com)
- Matt Jones
- Joel Carter
- Jordan Trouw

License

> See the LICENSE file for license details

Credits

Made with 🔥 and ❄️ by XYLabs

[logo]: https://cdn.xy.company/img/brand/XYPersistentCompany_Logo_Icon_Colored.svg

[main-build]: https://github.com/xylabs/sdk-js/actions/workflows/build.yml/badge.svg
[main-build-link]: https://github.com/xylabs/sdk-js/actions/workflows/build.yml
[npm-badge]: https://img.shields.io/npm/v/@xylabs/logger.svg
[npm-link]: https://www.npmjs.com/package/@xylabs/logger
[codacy-badge]: https://app.codacy.com/project/badge/Grade/c8e15e14f37741c18cfb47ac7245c698
[codacy-link]: https://www.codacy.com/gh/xylabs/sdk-js/dashboard?utm_source=github.com&utm_medium=referral&utm_content=xylabs/sdk-js&utm_campaign=Badge_Grade
[codeclimate-badge]: https://api.codeclimate.com/v1/badges/c5eb068f806f0b047ea7/maintainability
[codeclimate-link]: https://codeclimate.com/github/xylabs/sdk-js/maintainability
[snyk-badge]: https://snyk.io/test/github/xylabs/sdk-js/badge.svg?targetFile=package.json
[snyk-link]: https://snyk.io/test/github/xylabs/sdk-js?targetFile=package.json

[npm-downloads-badge]: https://img.shields.io/npm/dw/@xylabs/logger
[npm-license-badge]: https://img.shields.io/npm/l/@xylabs/logger

[jsdelivr-badge]: https://data.jsdelivr.com/v1/package/npm/@xylabs/logger/badge
[jsdelivr-link]: https://www.jsdelivr.com/package/npm/@xylabs/logger

[socket-badge]: https://socket.dev/api/badge/npm/package/@xylabs/logger
[socket-link]: https://socket.dev/npm/package/@xylabs/logger