@xylabs/logger 4.13.20 → 4.13.22

package/README.md

@@ -12,13 +12,922 @@
 [![snyk-badge][]][snyk-link]
 [![socket-badge][]][socket-link]
 
-Version: 4.13.19
 
 XYLabs Logger Library
 
-## Documentation
+## Reference
+
+**@xylabs/logger**
+
+***
+
+## Classes
+
+- [ConsoleLogger](#classes/ConsoleLogger)
+- [IdLogger](#classes/IdLogger)
+- [LevelLogger](#classes/LevelLogger)
+- [SilentLogger](#classes/SilentLogger)
+
+## Interfaces
+
+- [Logger](#interfaces/Logger)
+
+## Type Aliases
+
+- [LogFunction](#type-aliases/LogFunction)
+- [~~LogLevel~~](#type-aliases/LogLevel)
+- [LogLevelKey](#type-aliases/LogLevelKey)
+- [LogVerbosity](#type-aliases/LogVerbosity)
+- [LogLevelValue](#type-aliases/LogLevelValue)
+
+## Variables
+
+- [LogLevel](#variables/LogLevel)
+
+## Functions
+
+- [NoOpLogFunction](#functions/NoOpLogFunction)
+- [getFunctionName](#functions/getFunctionName)
+
+### classes
+
+  ### <a id="ConsoleLogger"></a>ConsoleLogger
+
+[**@xylabs/logger**](#../README)
+
+***
+
+Interface to handle overlap between Winston &
+`console` with as much congruency as possible.
+
+## Extends
+
+- [`LevelLogger`](#LevelLogger)
+
+## Constructors
+
+### Constructor
+
+```ts
+new ConsoleLogger(level): ConsoleLogger;
+```
+
+### Parameters
+
+#### level
+
+[`LogLevelValue`](#../type-aliases/LogLevelValue) = `LogLevel.warn`
+
+### Returns
+
+`ConsoleLogger`
+
+### Overrides
+
+[`LevelLogger`](#LevelLogger).[`constructor`](LevelLogger.md#constructor)
+
+## Properties
+
+### level
+
+```ts
+readonly level: LogLevelValue;
+```
+
+### Inherited from
+
+[`LevelLogger`](#LevelLogger).[`level`](LevelLogger.md#level)
+
+***
+
+### logger
+
+```ts
+readonly logger: Logger;
+```
+
+### Inherited from
+
+[`LevelLogger`](#LevelLogger).[`logger`](LevelLogger.md#logger)
+
+## Accessors
+
+### debug
+
+### Get Signature
+
+```ts
+get debug(): LogFunction;
+```
+
+#### Returns
+
+[`LogFunction`](#../type-aliases/LogFunction)
+
+### Inherited from
+
+[`LevelLogger`](#LevelLogger).[`debug`](LevelLogger.md#debug)
+
+***
+
+### error
+
+### Get Signature
+
+```ts
+get error(): LogFunction;
+```
+
+#### Returns
+
+[`LogFunction`](#../type-aliases/LogFunction)
+
+### Inherited from
+
+[`LevelLogger`](#LevelLogger).[`error`](LevelLogger.md#error)
+
+***
+
+### info
+
+### Get Signature
+
+```ts
+get info(): LogFunction;
+```
+
+#### Returns
+
+[`LogFunction`](#../type-aliases/LogFunction)
+
+### Inherited from
+
+[`LevelLogger`](#LevelLogger).[`info`](LevelLogger.md#info)
+
+***
+
+### log
+
+### Get Signature
+
+```ts
+get log(): LogFunction;
+```
+
+#### Returns
+
+[`LogFunction`](#../type-aliases/LogFunction)
+
+### Inherited from
+
+[`LevelLogger`](#LevelLogger).[`log`](LevelLogger.md#log)
+
+***
+
+### trace
+
+### Get Signature
+
+```ts
+get trace(): LogFunction;
+```
+
+#### Returns
+
+[`LogFunction`](#../type-aliases/LogFunction)
+
+### Inherited from
+
+[`LevelLogger`](#LevelLogger).[`trace`](LevelLogger.md#trace)
+
+***
+
+### warn
+
+### Get Signature
+
+```ts
+get warn(): LogFunction;
+```
+
+#### Returns
+
+[`LogFunction`](#../type-aliases/LogFunction)
+
+### Inherited from
+
+[`LevelLogger`](#LevelLogger).[`warn`](LevelLogger.md#warn)
+
+  ### <a id="IdLogger"></a>IdLogger
+
+[**@xylabs/logger**](#../README)
+
+***
+
+Interface to handle overlap between Winston &
+`console` with as much congruency as possible.
+
+## Implements
+
+- [`Logger`](#../interfaces/Logger)
+
+## Constructors
+
+### Constructor
+
+```ts
+new IdLogger(logger, id?): IdLogger;
+```
+
+### Parameters
+
+#### logger
+
+[`Logger`](#../interfaces/Logger)
+
+#### id?
+
+() => `string`
+
+### Returns
+
+`IdLogger`
+
+## Accessors
+
+### id
+
+### Set Signature
+
+```ts
+set id(id): void;
+```
+
+#### Parameters
+
+##### id
+
+`string`
+
+#### Returns
+
+`void`
+
+## Methods
+
+### debug()
+
+```ts
+debug(...data): void;
+```
+
+### Parameters
+
+#### data
+
+...`unknown`[]
+
+### Returns
+
+`void`
+
+### Implementation of
+
+```ts
+Logger.debug
+```
+
+***
+
+### error()
+
+```ts
+error(...data): void;
+```
+
+### Parameters
+
+#### data
+
+...`unknown`[]
+
+### Returns
+
+`void`
+
+### Implementation of
+
+```ts
+Logger.error
+```
+
+***
+
+### info()
+
+```ts
+info(...data): void;
+```
+
+### Parameters
+
+#### data
+
+...`unknown`[]
+
+### Returns
+
+`void`
+
+### Implementation of
+
+```ts
+Logger.info
+```
+
+***
+
+### log()
+
+```ts
+log(...data): void;
+```
+
+### Parameters
+
+#### data
+
+...`unknown`[]
+
+### Returns
+
+`void`
+
+### Implementation of
+
+```ts
+Logger.log
+```
+
+***
+
+### trace()
+
+```ts
+trace(...data): void;
+```
+
+### Parameters
+
+#### data
+
+...`unknown`[]
+
+### Returns
+
+`void`
+
+### Implementation of
+
+```ts
+Logger.trace
+```
+
+***
+
+### warn()
+
+```ts
+warn(...data): void;
+```
+
+### Parameters
+
+#### data
+
+...`unknown`[]
+
+### Returns
+
+`void`
+
+### Implementation of
+
+```ts
+Logger.warn
+```
+
+  ### <a id="LevelLogger"></a>LevelLogger
+
+[**@xylabs/logger**](#../README)
+
+***
+
+Interface to handle overlap between Winston &
+`console` with as much congruency as possible.
+
+## Extended by
+
+- [`ConsoleLogger`](#ConsoleLogger)
+
+## Implements
+
+- [`Logger`](#../interfaces/Logger)
+
+## Constructors
+
+### Constructor
+
+```ts
+new LevelLogger(logger, level): LevelLogger;
+```
+
+### Parameters
+
+#### logger
+
+[`Logger`](#../interfaces/Logger)
+
+#### level
+
+[`LogLevelValue`](#../type-aliases/LogLevelValue) = `LogLevel.warn`
+
+### Returns
+
+`LevelLogger`
+
+## Properties
+
+### level
+
+```ts
+readonly level: LogLevelValue;
+```
+
+***
+
+### logger
+
+```ts
+readonly logger: Logger;
+```
+
+## Accessors
+
+### debug
+
+### Get Signature
+
+```ts
+get debug(): LogFunction;
+```
+
+#### Returns
+
+[`LogFunction`](#../type-aliases/LogFunction)
+
+### Implementation of
+
+[`Logger`](#../interfaces/Logger).[`debug`](../interfaces/Logger.md#debug)
+
+***
+
+### error
+
+### Get Signature
+
+```ts
+get error(): LogFunction;
+```
+
+#### Returns
+
+[`LogFunction`](#../type-aliases/LogFunction)
+
+### Implementation of
+
+[`Logger`](#../interfaces/Logger).[`error`](../interfaces/Logger.md#error)
+
+***
+
+### info
+
+### Get Signature
+
+```ts
+get info(): LogFunction;
+```
+
+#### Returns
+
+[`LogFunction`](#../type-aliases/LogFunction)
+
+### Implementation of
+
+[`Logger`](#../interfaces/Logger).[`info`](../interfaces/Logger.md#info)
+
+***
+
+### log
+
+### Get Signature
+
+```ts
+get log(): LogFunction;
+```
+
+#### Returns
+
+[`LogFunction`](#../type-aliases/LogFunction)
+
+### Implementation of
+
+[`Logger`](#../interfaces/Logger).[`log`](../interfaces/Logger.md#log)
+
+***
+
+### trace
+
+### Get Signature
+
+```ts
+get trace(): LogFunction;
+```
+
+#### Returns
+
+[`LogFunction`](#../type-aliases/LogFunction)
+
+### Implementation of
+
+[`Logger`](#../interfaces/Logger).[`trace`](../interfaces/Logger.md#trace)
+
+***
+
+### warn
+
+### Get Signature
+
+```ts
+get warn(): LogFunction;
+```
+
+#### Returns
+
+[`LogFunction`](#../type-aliases/LogFunction)
+
+### Implementation of
+
+[`Logger`](#../interfaces/Logger).[`warn`](../interfaces/Logger.md#warn)
+
+  ### <a id="SilentLogger"></a>SilentLogger
+
+[**@xylabs/logger**](#../README)
+
+***
+
+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`](#../interfaces/Logger)
+
+## Constructors
+
+### Constructor
+
+```ts
+new SilentLogger(): SilentLogger;
+```
+
+### Returns
+
+`SilentLogger`
+
+## Properties
+
+### debug()
+
+```ts
+readonly debug: (..._data) => undefined = NoOpLogFunction;
+```
+
+### Parameters
+
+#### \_data
+
+...`unknown`[]
+
+### Returns
+
+`undefined`
+
+### Implementation of
+
+[`Logger`](#../interfaces/Logger).[`debug`](../interfaces/Logger.md#debug)
+
+***
+
+### error()
+
+```ts
+readonly error: (..._data) => undefined = NoOpLogFunction;
+```
+
+### Parameters
+
+#### \_data
+
+...`unknown`[]
+
+### Returns
+
+`undefined`
+
+### Implementation of
+
+[`Logger`](#../interfaces/Logger).[`error`](../interfaces/Logger.md#error)
+
+***
+
+### info()
+
+```ts
+readonly info: (..._data) => undefined = NoOpLogFunction;
+```
+
+### Parameters
+
+#### \_data
+
+...`unknown`[]
+
+### Returns
+
+`undefined`
+
+### Implementation of
+
+[`Logger`](#../interfaces/Logger).[`info`](../interfaces/Logger.md#info)
+
+***
+
+### log()
+
+```ts
+readonly log: (..._data) => undefined = NoOpLogFunction;
+```
+
+### Parameters
+
+#### \_data
+
+...`unknown`[]
+
+### Returns
+
+`undefined`
+
+### Implementation of
+
+[`Logger`](#../interfaces/Logger).[`log`](../interfaces/Logger.md#log)
+
+***
+
+### trace()
+
+```ts
+readonly trace: (..._data) => undefined = NoOpLogFunction;
+```
+
+### Parameters
+
+#### \_data
+
+...`unknown`[]
+
+### Returns
+
+`undefined`
+
+### Implementation of
+
+[`Logger`](#../interfaces/Logger).[`trace`](../interfaces/Logger.md#trace)
+
+***
+
+### warn()
+
+```ts
+readonly warn: (..._data) => undefined = NoOpLogFunction;
+```
+
+### Parameters
+
+#### \_data
+
+...`unknown`[]
+
+### Returns
+
+`undefined`
+
+### Implementation of
+
+[`Logger`](#../interfaces/Logger).[`warn`](../interfaces/Logger.md#warn)
+
+### functions
+
+  ### <a id="NoOpLogFunction"></a>NoOpLogFunction
+
+[**@xylabs/logger**](#../README)
+
+***
+
+```ts
+function NoOpLogFunction(..._data): undefined;
+```
+
+## Parameters
+
+### \_data
+
+...`unknown`[]
+
+## Returns
+
+`undefined`
+
+  ### <a id="getFunctionName"></a>getFunctionName
+
+[**@xylabs/logger**](#../README)
+
+***
+
+```ts
+function getFunctionName(depth): string;
+```
+
+## Parameters
+
+### depth
+
+`number` = `2`
+
+## Returns
+
+`string`
+
+### interfaces
+
+  ### <a id="Logger"></a>Logger
+
+[**@xylabs/logger**](#../README)
+
+***
+
+Interface to handle overlap between Winston &
+`console` with as much congruency as possible.
+
+## Properties
+
+### debug
+
+```ts
+debug: LogFunction;
+```
+
+***
+
+### error
+
+```ts
+error: LogFunction;
+```
+
+***
+
+### info
+
+```ts
+info: LogFunction;
+```
+
+***
+
+### log
+
+```ts
+log: LogFunction;
+```
+
+***
+
+### trace
+
+```ts
+trace: LogFunction;
+```
+
+***
+
+### warn
+
+```ts
+warn: LogFunction;
+```
+
+### type-aliases
+
+  ### <a id="LogFunction"></a>LogFunction
+
+[**@xylabs/logger**](#../README)
+
+***
+
+```ts
+type LogFunction = (...data) => void;
+```
+
+## Parameters
+
+### data
+
+...`unknown`[]
+
+## Returns
+
+`void`
+
+  ### <a id="LogLevel"></a>LogLevel
+
+[**@xylabs/logger**](#../README)
+
+***
+
+```ts
+type LogLevel = LogLevelValue;
+```
+
+## Deprecated
+
+Use `LogLevelValue` instead.
+This name conflicts with the `LogLevel` enum and
+makes it confusing to import
+
+  ### <a id="LogLevelKey"></a>LogLevelKey
+
+[**@xylabs/logger**](#../README)
+
+***
+
+```ts
+type LogLevelKey = EnumKey<typeof LogLevel>;
+```
+
+  ### <a id="LogLevelValue"></a>LogLevelValue
+
+[**@xylabs/logger**](#../README)
+
+***
+
+```ts
+type LogLevelValue = EnumValue<typeof LogLevel>;
+```
+
+  ### <a id="LogVerbosity"></a>LogVerbosity
+
+[**@xylabs/logger**](#../README)
+
+***
+
+```ts
+type LogVerbosity = LogLevelKey;
+```
+
+### variables
+
+  ### <a id="LogLevel"></a>LogLevel
+
+[**@xylabs/logger**](#../README)
+
+***
+
+```ts
+const LogLevel: Enum<{
+  error: 1;
+  warn: 2;
+  info: 3;
+  log: 4;
+  debug: 5;
+  trace: 6;
+}>;
+```
 
-Coming Soon!
 
 Part of [sdk-js](https://www.npmjs.com/package/@xyo-network/sdk-js)
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@xylabs/logger",
-  "version": "4.13.20",
+  "version": "4.13.22",
   "description": "XYLabs Logger Library",
   "keywords": [
     "logger",
@@ -42,12 +42,12 @@
     "src"
   ],
   "dependencies": {
-    "@xylabs/enum": "^4.13.20",
-    "@xylabs/error": "^4.13.20",
-    "@xylabs/typeof": "^4.13.20"
+    "@xylabs/enum": "^4.13.22",
+    "@xylabs/error": "^4.13.22",
+    "@xylabs/typeof": "^4.13.22"
   },
   "devDependencies": {
-    "@types/node": "^24.0.14",
+    "@types/node": "^24.0.15",
     "@xylabs/ts-scripts-yarn3": "^7.0.0",
     "@xylabs/tsconfig": "^7.0.0",
     "typescript": "^5.8.3",