@decaf-ts/logging 0.10.0 → 0.10.2

package/lib/esm/constants.js

@@ -1,30 +1,27 @@
 /**
- * @description Global key used to store environment variables in browser contexts.
- * @summary Enables the logging environment helpers to locate serialized environment configuration on `globalThis`.
- * @const BrowserEnvKey
- * @type {string}
+ * @description The global key that is used to store environment variables in browser contexts.
+ * @summary This enables the logging environment helpers to locate serialized environment configuration on `globalThis`.
+ * @const {string} BrowserEnvKey
  * @memberOf module:Logging
  */
 export const BrowserEnvKey = "ENV";
 /**
- * @description Delimiter used for composing nested environment variable names.
- * @summary Joins parent and child keys when mapping object paths to ENV strings.
- * @const ENV_PATH_DELIMITER
- * @type {string}
+ * @description The delimiter that is used for composing nested environment variable names.
+ * @summary This joins parent and child keys when mapping object paths to ENV strings.
+ * @const {string} ENV_PATH_DELIMITER
  * @memberOf module:Logging
  */
 export const ENV_PATH_DELIMITER = "__";
 /**
- * @description Default prefix and suffix used for template placeholders.
- * @summary Provides wrapper strings applied when interpolating messages with {@link patchPlaceholders}.
- * @const DefaultPlaceholderWrappers
- * @type {string[]}
+ * @description The default prefix and suffix that are used for template placeholders.
+ * @summary This provides wrapper strings that are applied when interpolating messages with {@link patchPlaceholders}.
+ * @const {string[]} DefaultPlaceholderWrappers
  * @memberOf module:Logging
  */
 export const DefaultPlaceholderWrappers = ["${", "}"];
 /**
- * @description Enum for log levels.
- * @summary Defines different levels of logging for the application.
+ * @description An enum for log levels.
+ * @summary Defines the different levels of logging for the application.
  * @enum {string}
  * @readonly
  * @memberOf module:Logging
@@ -49,22 +46,23 @@ export var LogLevel;
     LogLevel["silly"] = "silly";
 })(LogLevel || (LogLevel = {}));
 /**
- * @description Numeric values associated with log levels.
- * @summary Provides a numeric representation of log levels for comparison and filtering.
- * @typedef {Object} NumericLogLevelsShape
- * @property {number} benchmark - Numeric value for benchmark level (0).
- * @property {number} error - Numeric value for error level (2).
- * @property {number} info - Numeric value for info level (4).
- * @property {number} verbose - Numeric value for verbose level (6).
- * @property {number} debug - Numeric value for debug level (7).
- * @property {number} silly - Numeric value for silly level (9).
+ * @description The numeric values that are associated with log levels.
+ * @summary This provides a numeric representation of log levels for comparison and filtering.
+ * @typedef {object} NumericLogLevelsShape
+ * @property {number} benchmark - The numeric value for the benchmark level (0).
+ * @property {number} error - The numeric value for the error level (3).
+ * @property {number} warn - The numeric value for the warn level (6).
+ * @property {number} info - The numeric value for the info level (9).
+ * @property {number} verbose - The numeric value for the verbose level (12).
+ * @property {number} debug - The numeric value for the debug level (15).
+ * @property {number} trace - The numeric value for the trace level (18).
+ * @property {number} silly - The numeric value for the silly level (21).
  * @memberOf module:Logging
  */
 /**
- * @description Numeric values associated with log levels.
- * @summary Provides a numeric representation of log levels for comparison and filtering.
- * @const NumericLogLevels
- * @type {NumericLogLevelsShape}
+ * @description The numeric values that are associated with log levels.
+ * @summary This provides a numeric representation of log levels for comparison and filtering.
+ * @const {NumericLogLevelsShape} NumericLogLevels
  * @memberOf module:Logging
  */
 export const NumericLogLevels = {
@@ -78,9 +76,10 @@ export const NumericLogLevels = {
     silly: 21,
 };
 /**
- * @description Enum for logging output modes.
- * @summary Defines different output formats for log messages.
+ * @description An enum for logging output modes.
+ * @summary Defines the different output formats for log messages.
  * @enum {string}
+ * @readonly
  * @memberOf module:Logging
  */
 export var LoggingMode;
@@ -91,28 +90,9 @@ export var LoggingMode;
     LoggingMode["JSON"] = "json";
 })(LoggingMode || (LoggingMode = {}));
 /**
- * @description Default theme for styling log output.
+ * @description The default theme for styling log output.
  * @summary Defines the default color and style settings for various components of log messages.
- * @typedef {Theme} DefaultTheme
- * @property {Object} class - Styling for class names.
- * @property {number} class.fg - Foreground color code for class names (34).
- * @property {Object} id - Styling for identifiers.
- * @property {number} id.fg - Foreground color code for identifiers (36).
- * @property {Object} stack - Styling for stack traces (empty object).
- * @property {Object} timestamp - Styling for timestamps (empty object).
- * @property {Object} message - Styling for different types of messages.
- * @property {Object} message.error - Styling for error messages.
- * @property {number} message.error.fg - Foreground color code for error messages (31).
- * @property {Object} method - Styling for method names (empty object).
- * @property {Object} logLevel - Styling for different log levels.
- * @property {Object} logLevel.error - Styling for error level logs.
- * @property {number} logLevel.error.fg - Foreground color code for error level logs (31).
- * @property {string[]} logLevel.error.style - Style attributes for error level logs (["bold"]).
- * @property {Object} logLevel.info - Styling for info level logs (empty object).
- * @property {Object} logLevel.verbose - Styling for verbose level logs (empty object).
- * @property {Object} logLevel.debug - Styling for debug level logs.
- * @property {number} logLevel.debug.fg - Foreground color code for debug level logs (33).
- * @const DefaultTheme
+ * @const {Theme} DefaultTheme
  * @memberOf module:Logging
  */
 export const DefaultTheme = {
@@ -164,20 +144,9 @@ export const DefaultTheme = {
     },
 };
 /**
- * @description Default configuration for logging.
+ * @description The default configuration for logging.
  * @summary Defines the default settings for the logging system, including verbosity, log level, styling, and timestamp format.
- * @const DefaultLoggingConfig
- * @typedef {LoggingConfig} DefaultLoggingConfig
- * @property {number} verbose - Verbosity level (0).
- * @property {LogLevel} level - Default log level (LogLevel.info).
- * @property {boolean} logLevel - Whether to display log level in output (true).
- * @property {LoggingMode} mode - Output format mode (LoggingMode.RAW).
- * @property {boolean} style - Whether to apply styling to log output (false).
- * @property {string} separator - Separator between log components (" - ").
- * @property {boolean} timestamp - Whether to include timestamps in log messages (true).
- * @property {string} timestampFormat - Format for timestamps ("HH:mm:ss.SSS").
- * @property {boolean} context - Whether to include context information in log messages (true).
- * @property {Theme} theme - The theme to use for styling log messages (DefaultTheme).
+ * @const {LoggingConfig} DefaultLoggingConfig
  * @memberOf module:Logging
  */
 export const DefaultLoggingConfig = {

package/lib/esm/constants.js.map

@@ -1 +1 @@
-{"version":3,"file":"constants.js","sourceRoot":"","sources":["../../src/constants.ts"],"names":[],"mappings":"AAEA;;;;;;GAMG;AACH,MAAM,CAAC,MAAM,aAAa,GAAG,KAAK,CAAC;AAEnC;;;;;;GAMG;AACH,MAAM,CAAC,MAAM,kBAAkB,GAAG,IAAI,CAAC;AAEvC;;;;;;GAMG;AACH,MAAM,CAAC,MAAM,0BAA0B,GAAG,CAAC,IAAI,EAAE,GAAG,CAAC,CAAC;AAEtD;;;;;;GAMG;AACH,MAAM,CAAN,IAAY,QAiBX;AAjBD,WAAY,QAAQ;IAClB,sEAAsE;IACtE,mCAAuB,CAAA;IACvB,4EAA4E;IAC5E,2BAAe,CAAA;IACf,4DAA4D;IAC5D,yBAAa,CAAA;IACb,qEAAqE;IACrE,yBAAa,CAAA;IACb,wEAAwE;IACxE,+BAAmB,CAAA;IACnB,+DAA+D;IAC/D,2BAAe,CAAA;IACf,qDAAqD;IACrD,2BAAe,CAAA;IACf,4DAA4D;IAC5D,2BAAe,CAAA;AACjB,CAAC,EAjBW,QAAQ,KAAR,QAAQ,QAiBnB;AAED;;;;;;;;;;;GAWG;AACH;;;;;;GAMG;AACH,MAAM,CAAC,MAAM,gBAAgB,GAAG;IAC9B,SAAS,EAAE,CAAC;IACZ,KAAK,EAAE,CAAC;IACR,IAAI,EAAE,CAAC;IACP,IAAI,EAAE,CAAC;IACP,OAAO,EAAE,EAAE;IACX,KAAK,EAAE,EAAE;IACT,KAAK,EAAE,EAAE;IACT,KAAK,EAAE,EAAE;CACV,CAAC;AAEF;;;;;GAKG;AACH,MAAM,CAAN,IAAY,WAKX;AALD,WAAY,WAAW;IACrB,4CAA4C;IAC5C,0BAAW,CAAA;IACX,sCAAsC;IACtC,4BAAa,CAAA;AACf,CAAC,EALW,WAAW,KAAX,WAAW,QAKtB;AAED;;;;;;;;;;;;;;;;;;;;;;;;GAwBG;AACH,MAAM,CAAC,MAAM,YAAY,GAAU;IACjC,GAAG,EAAE,EAAE;IACP,SAAS,EAAE,EAAE;IACb,KAAK,EAAE;QACL,EAAE,EAAE,EAAE;KACP;IACD,EAAE,EAAE;QACF,EAAE,EAAE,EAAE;KACP;IACD,KAAK,EAAE,EAAE;IACT,SAAS,EAAE,EAAE;IACb,OAAO,EAAE;QACP,KAAK,EAAE;YACL,EAAE,EAAE,EAAE;SACP;KACF;IACD,MAAM,EAAE,EAAE;IACV,QAAQ,EAAE;QACR,SAAS,EAAE;YACT,EAAE,EAAE,EAAE;YACN,KAAK,EAAE,CAAC,MAAM,CAAC;SAChB;QACD,KAAK,EAAE;YACL,EAAE,EAAE,EAAE;YACN,KAAK,EAAE,CAAC,MAAM,CAAC;SAChB;QACD,IAAI,EAAE;YACJ,EAAE,EAAE,EAAE;YACN,KAAK,EAAE,CAAC,MAAM,CAAC;SAChB;QACD,OAAO,EAAE;YACP,EAAE,EAAE,EAAE;YACN,KAAK,EAAE,CAAC,MAAM,CAAC;SAChB;QACD,KAAK,EAAE;YACL,EAAE,EAAE,EAAE;YACN,KAAK,EAAE,CAAC,MAAM,CAAC;SAChB;QACD,KAAK,EAAE;YACL,EAAE,EAAE,EAAE;YACN,KAAK,EAAE,CAAC,MAAM,CAAC;SAChB;QACD,KAAK,EAAE;YACL,EAAE,EAAE,EAAE;YACN,KAAK,EAAE,CAAC,MAAM,CAAC;SAChB;KACF;CACF,CAAC;AAEF;;;;;;;;;;;;;;;;GAgBG;AACH,MAAM,CAAC,MAAM,oBAAoB,GAAkB;IACjD,GAAG,EAAE,aAAa;IAClB,OAAO,EAAE,CAAC;IACV,KAAK,EAAE,QAAQ,CAAC,IAAI;IACpB,QAAQ,EAAE,IAAI;IACd,KAAK,EAAE,KAAK;IACZ,gBAAgB,EAAE,GAAG;IACrB,SAAS,EAAE,GAAG;IACd,SAAS,EAAE,IAAI;IACf,eAAe,EAAE,cAAc;IAC/B,OAAO,EAAE,IAAI;IACb,MAAM,EAAE,WAAW,CAAC,GAAG;IACvB,OAAO,EACL,qEAAqE;IACvE,KAAK,EAAE,YAAY;CACpB,CAAC"}
+{"version":3,"file":"constants.js","sourceRoot":"","sources":["../../src/constants.ts"],"names":[],"mappings":"AAEA;;;;;GAKG;AACH,MAAM,CAAC,MAAM,aAAa,GAAG,KAAK,CAAC;AAEnC;;;;;GAKG;AACH,MAAM,CAAC,MAAM,kBAAkB,GAAG,IAAI,CAAC;AAEvC;;;;;GAKG;AACH,MAAM,CAAC,MAAM,0BAA0B,GAAG,CAAC,IAAI,EAAE,GAAG,CAAC,CAAC;AAEtD;;;;;;GAMG;AACH,MAAM,CAAN,IAAY,QAiBX;AAjBD,WAAY,QAAQ;IAClB,sEAAsE;IACtE,mCAAuB,CAAA;IACvB,4EAA4E;IAC5E,2BAAe,CAAA;IACf,4DAA4D;IAC5D,yBAAa,CAAA;IACb,qEAAqE;IACrE,yBAAa,CAAA;IACb,wEAAwE;IACxE,+BAAmB,CAAA;IACnB,+DAA+D;IAC/D,2BAAe,CAAA;IACf,qDAAqD;IACrD,2BAAe,CAAA;IACf,4DAA4D;IAC5D,2BAAe,CAAA;AACjB,CAAC,EAjBW,QAAQ,KAAR,QAAQ,QAiBnB;AAED;;;;;;;;;;;;;GAaG;AAEH;;;;;GAKG;AACH,MAAM,CAAC,MAAM,gBAAgB,GAAG;IAC9B,SAAS,EAAE,CAAC;IACZ,KAAK,EAAE,CAAC;IACR,IAAI,EAAE,CAAC;IACP,IAAI,EAAE,CAAC;IACP,OAAO,EAAE,EAAE;IACX,KAAK,EAAE,EAAE;IACT,KAAK,EAAE,EAAE;IACT,KAAK,EAAE,EAAE;CACV,CAAC;AAEF;;;;;;GAMG;AACH,MAAM,CAAN,IAAY,WAKX;AALD,WAAY,WAAW;IACrB,4CAA4C;IAC5C,0BAAW,CAAA;IACX,sCAAsC;IACtC,4BAAa,CAAA;AACf,CAAC,EALW,WAAW,KAAX,WAAW,QAKtB;AAED;;;;;GAKG;AACH,MAAM,CAAC,MAAM,YAAY,GAAU;IACjC,GAAG,EAAE,EAAE;IACP,SAAS,EAAE,EAAE;IACb,KAAK,EAAE;QACL,EAAE,EAAE,EAAE;KACP;IACD,EAAE,EAAE;QACF,EAAE,EAAE,EAAE;KACP;IACD,KAAK,EAAE,EAAE;IACT,SAAS,EAAE,EAAE;IACb,OAAO,EAAE;QACP,KAAK,EAAE;YACL,EAAE,EAAE,EAAE;SACP;KACF;IACD,MAAM,EAAE,EAAE;IACV,QAAQ,EAAE;QACR,SAAS,EAAE;YACT,EAAE,EAAE,EAAE;YACN,KAAK,EAAE,CAAC,MAAM,CAAC;SAChB;QACD,KAAK,EAAE;YACL,EAAE,EAAE,EAAE;YACN,KAAK,EAAE,CAAC,MAAM,CAAC;SAChB;QACD,IAAI,EAAE;YACJ,EAAE,EAAE,EAAE;YACN,KAAK,EAAE,CAAC,MAAM,CAAC;SAChB;QACD,OAAO,EAAE;YACP,EAAE,EAAE,EAAE;YACN,KAAK,EAAE,CAAC,MAAM,CAAC;SAChB;QACD,KAAK,EAAE;YACL,EAAE,EAAE,EAAE;YACN,KAAK,EAAE,CAAC,MAAM,CAAC;SAChB;QACD,KAAK,EAAE;YACL,EAAE,EAAE,EAAE;YACN,KAAK,EAAE,CAAC,MAAM,CAAC;SAChB;QACD,KAAK,EAAE;YACL,EAAE,EAAE,EAAE;YACN,KAAK,EAAE,CAAC,MAAM,CAAC;SAChB;KACF;CACF,CAAC;AAEF;;;;;GAKG;AACH,MAAM,CAAC,MAAM,oBAAoB,GAAkB;IACjD,GAAG,EAAE,aAAa;IAClB,OAAO,EAAE,CAAC;IACV,KAAK,EAAE,QAAQ,CAAC,IAAI;IACpB,QAAQ,EAAE,IAAI;IACd,KAAK,EAAE,KAAK;IACZ,gBAAgB,EAAE,GAAG;IACrB,SAAS,EAAE,GAAG;IACd,SAAS,EAAE,IAAI;IACf,eAAe,EAAE,cAAc;IAC/B,OAAO,EAAE,IAAI;IACb,MAAM,EAAE,WAAW,CAAC,GAAG;IACvB,OAAO,EACL,qEAAqE;IACvE,KAAK,EAAE,YAAY;CACpB,CAAC"}

package/lib/esm/decorators.d.ts

@@ -2,13 +2,13 @@ import { LogLevel } from "./constants";
 export type ArgFormatFunction = (...args: any[]) => string;
 export type ReturnFormatFunction = (e?: Error, result?: any) => string;
 /**
- * @description Method decorator for logging function calls.
- * @summary Wraps class methods to automatically log entry, exit, timing, and optional custom messages at a configurable {@link LogLevel}.
- * @param {LogLevel} level - Log level applied to the generated log statements (defaults to `LogLevel.info`).
- * @param {number} [verbosity=0] - Verbosity threshold required for the entry log to appear.
- * @param {ArgFormatFunction} [entryMessage] - Formatter invoked with the original method arguments to describe the invocation.
- * @param {ReturnFormatFunction} [exitMessage] - Optional formatter that describes the outcome or failure of the call.
- * @return {function(any, any, PropertyDescriptor): void} Method decorator proxy that injects logging behavior.
+ * @description A method decorator for logging function calls.
+ * @summary This decorator wraps a class method to automatically log entry, exit, timing, and optional custom messages at a configurable {@link LogLevel}.
+ * @param {LogLevel} [level=LogLevel.info] - The log level to apply to the generated log statements.
+ * @param {number} [verbosity=0] - The verbosity threshold that is required for the entry log to appear.
+ * @param {ArgFormatFunction} [entryMessage] - A formatter that is invoked with the original method arguments to describe the invocation.
+ * @param {ReturnFormatFunction} [exitMessage] - An optional formatter that describes the outcome or failure of the call.
+ * @return {function(any, any, PropertyDescriptor): void} A method decorator proxy that injects logging behavior.
  * @function log
  * @mermaid
  * sequenceDiagram
@@ -35,9 +35,9 @@ export type ReturnFormatFunction = (e?: Error, result?: any) => string;
  */
 export declare function log(level?: LogLevel, verbosity?: number, entryMessage?: ArgFormatFunction, exitMessage?: ReturnFormatFunction): (target: any, propertyKey?: any, descriptor?: any) => any;
 /**
- * @description Method decorator that records execution time at the benchmark level.
- * @summary Wraps the target method to emit {@link Logger.benchmark} entries capturing completion time or failure latency.
- * @return {function(any, any,  PropertyDescriptor): void} Method decorator proxy that benchmarks the original implementation.
+ * @description A method decorator that records execution time at the benchmark level.
+ * @summary This decorator wraps the target method to emit {@link Logger.benchmark} entries that capture completion time or failure latency.
+ * @return {function(any, any, PropertyDescriptor): void} A method decorator proxy that benchmarks the original implementation.
  * @function benchmark
  * @mermaid
  * sequenceDiagram
@@ -59,57 +59,50 @@ export declare function log(level?: LogLevel, verbosity?: number, entryMessage?:
  */
 export declare function benchmark(): (target: any, propertyKey?: any, descriptor?: any) => any;
 /**
- * @description Method decorator for logging function calls with debug level.
- * @summary Convenience wrapper around {@link log} that logs using `LogLevel.debug`.
- * @return {function(any, any, PropertyDescriptor): void} Debug-level logging decorator.
+ * @description A method decorator for logging function calls with the debug level.
+ * @summary This is a convenience wrapper around {@link log} that logs using `LogLevel.debug`.
+ * @return {function(any, any, PropertyDescriptor): void} A debug-level logging decorator.
  * @function debug
  * @category Method Decorators
  */
 export declare function debug(): (target: any, propertyKey?: any, descriptor?: any) => any;
 /**
- * @description Method decorator for logging function calls with info level.
- * @summary Convenience wrapper around {@link log} that logs using `LogLevel.info`.
- * @return {function(any, any, PropertyDescriptor): void} Info-level logging decorator.
+ * @description A method decorator for logging function calls with the info level.
+ * @summary This is a convenience wrapper around {@link log} that logs using `LogLevel.info`.
+ * @return {function(any, any, PropertyDescriptor): void} An info-level logging decorator.
  * @function info
  * @category Method Decorators
  */
 export declare function info(): (target: any, propertyKey?: any, descriptor?: any) => any;
 /**
- * @description Method decorator for logging function calls with silly level.
- * @summary Convenience wrapper around {@link log} that logs using `LogLevel.silly`.
- * @return {function(any, any, PropertyDescriptor): void} Silly-level logging decorator.
+ * @description A method decorator for logging function calls with the silly level.
+ * @summary This is a convenience wrapper around {@link log} that logs using `LogLevel.silly`.
+ * @return {function(any, any, PropertyDescriptor): void} A silly-level logging decorator.
  * @function silly
  * @category Method Decorators
  */
 export declare function silly(): (target: any, propertyKey?: any, descriptor?: any) => any;
 /**
- * @description Method decorator for logging function calls with trace level.
- * @summary Convenience wrapper around {@link log} that logs using `LogLevel.trace`.
- * @return {function(any, any, PropertyDescriptor): void} Trace-level logging decorator.
+ * @description A method decorator for logging function calls with the trace level.
+ * @summary This is a convenience wrapper around {@link log} that logs using `LogLevel.trace`.
+ * @return {function(any, any, PropertyDescriptor): void} A trace-level logging decorator.
  * @function trace
  * @category Method Decorators
  */
 export declare function trace(): (target: any, propertyKey?: any, descriptor?: any) => any;
 /**
- * @description Method decorator for logging function calls with verbose level.
- * @summary Convenience wrapper around {@link log} that logs using `LogLevel.verbose` with configurable verbosity.
- * @return {function(any, any, PropertyDescriptor): void} Verbose logging decorator.
+ * @description A method decorator for logging function calls with the verbose level.
+ * @summary This is a convenience wrapper around {@link log} that logs using `LogLevel.verbose` with a configurable verbosity.
+ * @param {(number|boolean)} [verbosity=0] - The verbosity level for log filtering or a flag to enable benchmarking.
+ * @return {function(any, any, PropertyDescriptor): void} A verbose logging decorator.
  * @function verbose
  * @category Method Decorators
  */
-export declare function verbose(): (target: any, propertyKey?: any, descriptor?: any) => void;
-/**
- * @description Method decorator for logging function calls with verbose level.
- * @summary Convenience wrapper around {@link log} that logs using `LogLevel.verbose` while toggling benchmarking.
- * @return {function(any, PropertyDescriptor): void} Verbose logging decorator.
- * @function verbose
- * @category Method Decorators
- */
-export declare function verbose(): (target: any, propertyKey?: any, descriptor?: any) => void;
+export declare function verbose(verbosity?: number | boolean): (target: any, propertyKey?: any, descriptor?: any) => any;
 /**
  * @description Creates a decorator that makes a method non-configurable.
- * @summary Prevents overriding by marking the method descriptor as non-configurable, throwing if applied to non-method targets.
- * @return {function(object, any, PropertyDescriptor): PropertyDescriptor|undefined} Decorator that hardens the method descriptor.
+ * @summary This decorator prevents overriding by marking the method descriptor as non-configurable. It will throw an error if it is applied to non-method targets.
+ * @return {function(object, any, PropertyDescriptor): (PropertyDescriptor|undefined)} A decorator that hardens the method descriptor.
  * @function final
  * @category Method Decorators
  */

package/lib/esm/decorators.js

@@ -3,13 +3,13 @@ import { Logging } from "./logging.js";
 import { now } from "./time.js";
 import { LoggedClass } from "./LoggedClass.js";
 /**
- * @description Method decorator for logging function calls.
- * @summary Wraps class methods to automatically log entry, exit, timing, and optional custom messages at a configurable {@link LogLevel}.
- * @param {LogLevel} level - Log level applied to the generated log statements (defaults to `LogLevel.info`).
- * @param {number} [verbosity=0] - Verbosity threshold required for the entry log to appear.
- * @param {ArgFormatFunction} [entryMessage] - Formatter invoked with the original method arguments to describe the invocation.
- * @param {ReturnFormatFunction} [exitMessage] - Optional formatter that describes the outcome or failure of the call.
- * @return {function(any, any, PropertyDescriptor): void} Method decorator proxy that injects logging behavior.
+ * @description A method decorator for logging function calls.
+ * @summary This decorator wraps a class method to automatically log entry, exit, timing, and optional custom messages at a configurable {@link LogLevel}.
+ * @param {LogLevel} [level=LogLevel.info] - The log level to apply to the generated log statements.
+ * @param {number} [verbosity=0] - The verbosity threshold that is required for the entry log to appear.
+ * @param {ArgFormatFunction} [entryMessage] - A formatter that is invoked with the original method arguments to describe the invocation.
+ * @param {ReturnFormatFunction} [exitMessage] - An optional formatter that describes the outcome or failure of the call.
+ * @return {function(any, any, PropertyDescriptor): void} A method decorator proxy that injects logging behavior.
  * @function log
  * @mermaid
  * sequenceDiagram
@@ -76,9 +76,9 @@ export function log(level = LogLevel.info, verbosity = 0, entryMessage = (...arg
     };
 }
 /**
- * @description Method decorator that records execution time at the benchmark level.
- * @summary Wraps the target method to emit {@link Logger.benchmark} entries capturing completion time or failure latency.
- * @return {function(any, any,  PropertyDescriptor): void} Method decorator proxy that benchmarks the original implementation.
+ * @description A method decorator that records execution time at the benchmark level.
+ * @summary This decorator wraps the target method to emit {@link Logger.benchmark} entries that capture completion time or failure latency.
+ * @return {function(any, any, PropertyDescriptor): void} A method decorator proxy that benchmarks the original implementation.
  * @function benchmark
  * @mermaid
  * sequenceDiagram
@@ -135,9 +135,9 @@ export function benchmark() {
     };
 }
 /**
- * @description Method decorator for logging function calls with debug level.
- * @summary Convenience wrapper around {@link log} that logs using `LogLevel.debug`.
- * @return {function(any, any, PropertyDescriptor): void} Debug-level logging decorator.
+ * @description A method decorator for logging function calls with the debug level.
+ * @summary This is a convenience wrapper around {@link log} that logs using `LogLevel.debug`.
+ * @return {function(any, any, PropertyDescriptor): void} A debug-level logging decorator.
  * @function debug
  * @category Method Decorators
  */
@@ -149,9 +149,9 @@ export function debug() {
             : "completed");
 }
 /**
- * @description Method decorator for logging function calls with info level.
- * @summary Convenience wrapper around {@link log} that logs using `LogLevel.info`.
- * @return {function(any, any, PropertyDescriptor): void} Info-level logging decorator.
+ * @description A method decorator for logging function calls with the info level.
+ * @summary This is a convenience wrapper around {@link log} that logs using `LogLevel.info`.
+ * @return {function(any, any, PropertyDescriptor): void} An info-level logging decorator.
  * @function info
  * @category Method Decorators
  */
@@ -159,9 +159,9 @@ export function info() {
     return log(LogLevel.info);
 }
 /**
- * @description Method decorator for logging function calls with silly level.
- * @summary Convenience wrapper around {@link log} that logs using `LogLevel.silly`.
- * @return {function(any, any, PropertyDescriptor): void} Silly-level logging decorator.
+ * @description A method decorator for logging function calls with the silly level.
+ * @summary This is a convenience wrapper around {@link log} that logs using `LogLevel.silly`.
+ * @return {function(any, any, PropertyDescriptor): void} A silly-level logging decorator.
  * @function silly
  * @category Method Decorators
  */
@@ -169,9 +169,9 @@ export function silly() {
     return log(LogLevel.silly);
 }
 /**
- * @description Method decorator for logging function calls with trace level.
- * @summary Convenience wrapper around {@link log} that logs using `LogLevel.trace`.
- * @return {function(any, any, PropertyDescriptor): void} Trace-level logging decorator.
+ * @description A method decorator for logging function calls with the trace level.
+ * @summary This is a convenience wrapper around {@link log} that logs using `LogLevel.trace`.
+ * @return {function(any, any, PropertyDescriptor): void} A trace-level logging decorator.
  * @function trace
  * @category Method Decorators
  */
@@ -179,10 +179,10 @@ export function trace() {
     return log(LogLevel.trace);
 }
 /**
- * @description Method decorator for logging function calls with verbose level.
- * @summary Convenience wrapper around {@link log} that logs using `LogLevel.verbose` with configurable verbosity and optional benchmarking.
- * @param {number|boolean} verbosity - Verbosity level for log filtering or flag to enable benchmarking.
- * @return {function(any, any,PropertyDescriptor): void} Verbose logging decorator.
+ * @description A method decorator for logging function calls with the verbose level.
+ * @summary This is a convenience wrapper around {@link log} that logs using `LogLevel.verbose` with a configurable verbosity.
+ * @param {(number|boolean)} [verbosity=0] - The verbosity level for log filtering or a flag to enable benchmarking.
+ * @return {function(any, any, PropertyDescriptor): void} A verbose logging decorator.
  * @function verbose
  * @category Method Decorators
  */
@@ -194,8 +194,8 @@ export function verbose(verbosity = 0) {
 }
 /**
  * @description Creates a decorator that makes a method non-configurable.
- * @summary Prevents overriding by marking the method descriptor as non-configurable, throwing if applied to non-method targets.
- * @return {function(object, any, PropertyDescriptor): PropertyDescriptor|undefined} Decorator that hardens the method descriptor.
+ * @summary This decorator prevents overriding by marking the method descriptor as non-configurable. It will throw an error if it is applied to non-method targets.
+ * @return {function(object, any, PropertyDescriptor): (PropertyDescriptor|undefined)} A decorator that hardens the method descriptor.
  * @function final
  * @category Method Decorators
  */

package/lib/esm/decorators.js.map

@@ -1 +1 @@
-{"version":3,"file":"decorators.js","sourceRoot":"","sources":["../../src/decorators.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,uBAAoB;AACvC,OAAO,EAAE,OAAO,EAAE,qBAAkB;AACpC,OAAO,EAAE,GAAG,EAAE,kBAAe;AAC7B,OAAO,EAAE,WAAW,EAAE,yBAAsB;AAM5C;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA+BG;AACH,MAAM,UAAU,GAAG,CACjB,QAAkB,QAAQ,CAAC,IAAI,EAC/B,SAAS,GAAG,CAAC,EACb,eAAkC,CAAC,GAAG,IAAW,EAAE,EAAE,CAAC,eAAe,IAAI,EAAE,EAC3E,WAAkC;IAElC,OAAO,SAAS,GAAG,CAAC,MAAW,EAAE,WAAiB,EAAE,UAAgB;QAClE,IAAI,CAAC,UAAU,IAAI,OAAO,UAAU,KAAK,QAAQ;YAC/C,MAAM,IAAI,KAAK,CAAC,4CAA4C,CAAC,CAAC;QAChE,MAAM,MAAM,GACV,MAAM,YAAY,WAAW;YAC3B,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,GAAG,CAAC,MAAM,CAAC,WAAkC,CAAC,CAAC;YAC/D,CAAC,CAAC,OAAO,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC,GAAG,CAAC,MAAM,CAAC,WAAW,CAAC,CAAC,CAAC;QACnD,MAAM,MAAM,GAAG,MAAM,CAAC,KAAK,CAAC,CAAC,IAAI,CAAC,MAAM,CAAQ,CAAC;QACjD,MAAM,cAAc,GAAG,UAAU,CAAC,KAAK,CAAC;QAExC,UAAU,CAAC,KAAK,GAAG,IAAI,KAAK,CAAC,cAAc,EAAE;YAC3C,KAAK,CAAC,EAAE,EAAE,OAAO,EAAE,IAAW;gBAC5B,MAAM,CAAC,YAAY,CAAC,GAAG,IAAI,CAAC,EAAE,SAAS,CAAC,CAAC;gBACzC,IAAI,CAAC;oBACH,MAAM,MAAM,GAAG,OAAO,CAAC,KAAK,CAAC,EAAE,EAAE,OAAO,EAAE,IAAI,CAAC,CAAC;oBAChD,IAAI,MAAM,YAAY,OAAO,EAAE,CAAC;wBAC9B,OAAO,MAAM;6BACV,IAAI,CAAC,CAAC,CAAM,EAAE,EAAE;4BACf,IAAI,WAAW;gCAAE,MAAM,CAAC,WAAW,CAAC,SAAS,EAAE,CAAC,CAAC,CAAC,CAAC;4BACnD,OAAO,CAAC,CAAC;wBACX,CAAC,CAAC;6BACD,KAAK,CAAC,CAAC,CAAC,EAAE,EAAE;4BACX,IAAI,WAAW;gCAAE,MAAM,CAAC,KAAK,CAAC,WAAW,CAAC,CAAU,CAAC,CAAC,CAAC;4BACvD,MAAM,CAAC,CAAC;wBACV,CAAC,CAAC,CAAC;oBACP,CAAC;oBACD,IAAI,WAAW;wBAAE,MAAM,CAAC,WAAW,CAAC,SAAS,EAAE,MAAM,CAAC,CAAC,CAAC;oBACxD,OAAO,MAAM,CAAC;gBAChB,CAAC;gBAAC,OAAO,GAAY,EAAE,CAAC;oBACtB,IAAI,WAAW;wBAAE,MAAM,CAAC,KAAK,CAAC,WAAW,CAAC,GAAY,CAAC,CAAC,CAAC;oBACzD,MAAM,GAAG,CAAC;gBACZ,CAAC;YACH,CAAC;SACF,CAAC,CAAC;QACH,OAAO,UAAU,CAAC;IACpB,CAAC,CAAC;AACJ,CAAC;AAED;;;;;;;;;;;;;;;;;;;;;;GAsBG;AACH,MAAM,UAAU,SAAS;IACvB,OAAO,SAAS,SAAS,CAAC,MAAW,EAAE,WAAiB,EAAE,UAAgB;QACxE,IAAI,CAAC,UAAU,IAAI,OAAO,UAAU,KAAK,QAAQ;YAC/C,MAAM,IAAI,KAAK,CAAC,8CAA8C,CAAC,CAAC;QAClE,MAAM,MAAM,GACV,MAAM,YAAY,WAAW;YAC3B,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,GAAG,CAAC,MAAM,CAAC,WAAkC,CAAC,CAAC;YAC/D,CAAC,CAAC,OAAO,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC,GAAG,CAAC,MAAM,CAAC,WAAW,CAAC,CAAC,CAAC;QACnD,MAAM,cAAc,GAAG,UAAU,CAAC,KAAK,CAAC;QAExC,UAAU,CAAC,KAAK,GAAG,IAAI,KAAK,CAAC,cAAc,EAAE;YAC3C,KAAK,CAAC,EAAE,EAAE,OAAO,EAAE,IAAW;gBAC5B,MAAM,KAAK,GAAG,GAAG,EAAE,CAAC;gBACpB,IAAI,CAAC;oBACH,MAAM,MAAM,GAAG,OAAO,CAAC,KAAK,CAAC,EAAE,EAAE,OAAO,EAAE,IAAI,CAAC,CAAC;oBAChD,IAAI,MAAM,YAAY,OAAO,EAAE,CAAC;wBAC9B,OAAO,MAAM;6BACV,IAAI,CAAC,CAAC,CAAM,EAAE,EAAE;4BACf,MAAM,CAAC,SAAS,CAAC,gBAAgB,GAAG,EAAE,GAAG,KAAK,IAAI,CAAC,CAAC;4BACpD,OAAO,CAAC,CAAC;wBACX,CAAC,CAAC;6BACD,KAAK,CAAC,CAAC,CAAC,EAAE,EAAE;4BACX,MAAM,CAAC,SAAS,CAAC,aAAa,GAAG,EAAE,GAAG,KAAK,IAAI,CAAC,CAAC;4BACjD,MAAM,CAAC,CAAC;wBACV,CAAC,CAAC,CAAC;oBACP,CAAC;oBACD,MAAM,CAAC,SAAS,CAAC,gBAAgB,GAAG,EAAE,GAAG,KAAK,IAAI,CAAC,CAAC;oBACpD,OAAO,MAAM,CAAC;gBAChB,CAAC;gBAAC,OAAO,GAAY,EAAE,CAAC;oBACtB,MAAM,CAAC,SAAS,CAAC,aAAa,GAAG,EAAE,GAAG,KAAK,IAAI,CAAC,CAAC;oBACjD,MAAM,GAAG,CAAC;gBACZ,CAAC;YACH,CAAC;SACF,CAAC,CAAC;QAEH,OAAO,UAAU,CAAC;IACpB,CAAC,CAAC;AACJ,CAAC;AAED;;;;;;GAMG;AACH,MAAM,UAAU,KAAK;IACnB,OAAO,GAAG,CACR,QAAQ,CAAC,KAAK,EACd,CAAC,EACD,CAAC,GAAG,IAAW,EAAE,EAAE,CAAC,eAAe,IAAI,EAAE,EACzC,CAAC,CAAS,EAAE,MAAY,EAAE,EAAE,CAC1B,CAAC;QACC,CAAC,CAAC,gBAAgB,CAAC,EAAE;QACrB,CAAC,CAAC,MAAM;YACN,CAAC,CAAC,kBAAkB,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,EAAE;YAC5C,CAAC,CAAC,WAAW,CACpB,CAAC;AACJ,CAAC;AAED;;;;;;GAMG;AACH,MAAM,UAAU,IAAI;IAClB,OAAO,GAAG,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;AAC5B,CAAC;AAED;;;;;;GAMG;AACH,MAAM,UAAU,KAAK;IACnB,OAAO,GAAG,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;AAC7B,CAAC;AAED;;;;;;GAMG;AACH,MAAM,UAAU,KAAK;IACnB,OAAO,GAAG,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;AAC7B,CAAC;AA4BD;;;;;;;GAOG;AACH,MAAM,UAAU,OAAO,CAAC,YAA8B,CAAC;IACrD,IAAI,CAAC,SAAS,EAAE,CAAC;QACf,SAAS,GAAG,CAAC,CAAC;IAChB,CAAC;IACD,OAAO,GAAG,CAAC,QAAQ,CAAC,OAAO,EAAE,SAAmB,CAAC,CAAC;AACpD,CAAC;AAED;;;;;;GAMG;AACH,MAAM,UAAU,KAAK;IACnB,OAAO,CAAC,MAAc,EAAE,WAAiB,EAAE,UAAgB,EAAE,EAAE;QAC7D,IAAI,CAAC,UAAU;YACb,MAAM,IAAI,KAAK,CAAC,6CAA6C,CAAC,CAAC;QACjE,IAAI,UAAU,EAAE,YAAY,EAAE,CAAC;YAC7B,UAAU,CAAC,YAAY,GAAG,KAAK,CAAC;QAClC,CAAC;QACD,OAAO,UAAU,CAAC;IACpB,CAAC,CAAC;AACJ,CAAC"}
+{"version":3,"file":"decorators.js","sourceRoot":"","sources":["../../src/decorators.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,uBAAoB;AACvC,OAAO,EAAE,OAAO,EAAE,qBAAkB;AACpC,OAAO,EAAE,GAAG,EAAE,kBAAe;AAC7B,OAAO,EAAE,WAAW,EAAE,yBAAsB;AAM5C;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA+BG;AACH,MAAM,UAAU,GAAG,CACjB,QAAkB,QAAQ,CAAC,IAAI,EAC/B,SAAS,GAAG,CAAC,EACb,eAAkC,CAAC,GAAG,IAAW,EAAE,EAAE,CAAC,eAAe,IAAI,EAAE,EAC3E,WAAkC;IAElC,OAAO,SAAS,GAAG,CAAC,MAAW,EAAE,WAAiB,EAAE,UAAgB;QAClE,IAAI,CAAC,UAAU,IAAI,OAAO,UAAU,KAAK,QAAQ;YAC/C,MAAM,IAAI,KAAK,CAAC,4CAA4C,CAAC,CAAC;QAChE,MAAM,MAAM,GACV,MAAM,YAAY,WAAW;YAC3B,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,GAAG,CAAC,MAAM,CAAC,WAAkC,CAAC,CAAC;YAC/D,CAAC,CAAC,OAAO,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC,GAAG,CAAC,MAAM,CAAC,WAAW,CAAC,CAAC,CAAC;QACnD,MAAM,MAAM,GAAG,MAAM,CAAC,KAAK,CAAC,CAAC,IAAI,CAAC,MAAM,CAAQ,CAAC;QACjD,MAAM,cAAc,GAAG,UAAU,CAAC,KAAK,CAAC;QAExC,UAAU,CAAC,KAAK,GAAG,IAAI,KAAK,CAAC,cAAc,EAAE;YAC3C,KAAK,CAAC,EAAE,EAAE,OAAO,EAAE,IAAW;gBAC5B,MAAM,CAAC,YAAY,CAAC,GAAG,IAAI,CAAC,EAAE,SAAS,CAAC,CAAC;gBACzC,IAAI,CAAC;oBACH,MAAM,MAAM,GAAG,OAAO,CAAC,KAAK,CAAC,EAAE,EAAE,OAAO,EAAE,IAAI,CAAC,CAAC;oBAChD,IAAI,MAAM,YAAY,OAAO,EAAE,CAAC;wBAC9B,OAAO,MAAM;6BACV,IAAI,CAAC,CAAC,CAAM,EAAE,EAAE;4BACf,IAAI,WAAW;gCAAE,MAAM,CAAC,WAAW,CAAC,SAAS,EAAE,CAAC,CAAC,CAAC,CAAC;4BACnD,OAAO,CAAC,CAAC;wBACX,CAAC,CAAC;6BACD,KAAK,CAAC,CAAC,CAAC,EAAE,EAAE;4BACX,IAAI,WAAW;gCAAE,MAAM,CAAC,KAAK,CAAC,WAAW,CAAC,CAAU,CAAC,CAAC,CAAC;4BACvD,MAAM,CAAC,CAAC;wBACV,CAAC,CAAC,CAAC;oBACP,CAAC;oBACD,IAAI,WAAW;wBAAE,MAAM,CAAC,WAAW,CAAC,SAAS,EAAE,MAAM,CAAC,CAAC,CAAC;oBACxD,OAAO,MAAM,CAAC;gBAChB,CAAC;gBAAC,OAAO,GAAY,EAAE,CAAC;oBACtB,IAAI,WAAW;wBAAE,MAAM,CAAC,KAAK,CAAC,WAAW,CAAC,GAAY,CAAC,CAAC,CAAC;oBACzD,MAAM,GAAG,CAAC;gBACZ,CAAC;YACH,CAAC;SACF,CAAC,CAAC;QACH,OAAO,UAAU,CAAC;IACpB,CAAC,CAAC;AACJ,CAAC;AAED;;;;;;;;;;;;;;;;;;;;;;GAsBG;AACH,MAAM,UAAU,SAAS;IACvB,OAAO,SAAS,SAAS,CAAC,MAAW,EAAE,WAAiB,EAAE,UAAgB;QACxE,IAAI,CAAC,UAAU,IAAI,OAAO,UAAU,KAAK,QAAQ;YAC/C,MAAM,IAAI,KAAK,CAAC,8CAA8C,CAAC,CAAC;QAClE,MAAM,MAAM,GACV,MAAM,YAAY,WAAW;YAC3B,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,GAAG,CAAC,MAAM,CAAC,WAAkC,CAAC,CAAC;YAC/D,CAAC,CAAC,OAAO,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC,GAAG,CAAC,MAAM,CAAC,WAAW,CAAC,CAAC,CAAC;QACnD,MAAM,cAAc,GAAG,UAAU,CAAC,KAAK,CAAC;QAExC,UAAU,CAAC,KAAK,GAAG,IAAI,KAAK,CAAC,cAAc,EAAE;YAC3C,KAAK,CAAC,EAAE,EAAE,OAAO,EAAE,IAAW;gBAC5B,MAAM,KAAK,GAAG,GAAG,EAAE,CAAC;gBACpB,IAAI,CAAC;oBACH,MAAM,MAAM,GAAG,OAAO,CAAC,KAAK,CAAC,EAAE,EAAE,OAAO,EAAE,IAAI,CAAC,CAAC;oBAChD,IAAI,MAAM,YAAY,OAAO,EAAE,CAAC;wBAC9B,OAAO,MAAM;6BACV,IAAI,CAAC,CAAC,CAAM,EAAE,EAAE;4BACf,MAAM,CAAC,SAAS,CAAC,gBAAgB,GAAG,EAAE,GAAG,KAAK,IAAI,CAAC,CAAC;4BACpD,OAAO,CAAC,CAAC;wBACX,CAAC,CAAC;6BACD,KAAK,CAAC,CAAC,CAAC,EAAE,EAAE;4BACX,MAAM,CAAC,SAAS,CAAC,aAAa,GAAG,EAAE,GAAG,KAAK,IAAI,CAAC,CAAC;4BACjD,MAAM,CAAC,CAAC;wBACV,CAAC,CAAC,CAAC;oBACP,CAAC;oBACD,MAAM,CAAC,SAAS,CAAC,gBAAgB,GAAG,EAAE,GAAG,KAAK,IAAI,CAAC,CAAC;oBACpD,OAAO,MAAM,CAAC;gBAChB,CAAC;gBAAC,OAAO,GAAY,EAAE,CAAC;oBACtB,MAAM,CAAC,SAAS,CAAC,aAAa,GAAG,EAAE,GAAG,KAAK,IAAI,CAAC,CAAC;oBACjD,MAAM,GAAG,CAAC;gBACZ,CAAC;YACH,CAAC;SACF,CAAC,CAAC;QAEH,OAAO,UAAU,CAAC;IACpB,CAAC,CAAC;AACJ,CAAC;AAED;;;;;;GAMG;AACH,MAAM,UAAU,KAAK;IACnB,OAAO,GAAG,CACR,QAAQ,CAAC,KAAK,EACd,CAAC,EACD,CAAC,GAAG,IAAW,EAAE,EAAE,CAAC,eAAe,IAAI,EAAE,EACzC,CAAC,CAAS,EAAE,MAAY,EAAE,EAAE,CAC1B,CAAC;QACC,CAAC,CAAC,gBAAgB,CAAC,EAAE;QACrB,CAAC,CAAC,MAAM;YACN,CAAC,CAAC,kBAAkB,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,EAAE;YAC5C,CAAC,CAAC,WAAW,CACpB,CAAC;AACJ,CAAC;AAED;;;;;;GAMG;AACH,MAAM,UAAU,IAAI;IAClB,OAAO,GAAG,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;AAC5B,CAAC;AAED;;;;;;GAMG;AACH,MAAM,UAAU,KAAK;IACnB,OAAO,GAAG,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;AAC7B,CAAC;AAED;;;;;;GAMG;AACH,MAAM,UAAU,KAAK;IACnB,OAAO,GAAG,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;AAC7B,CAAC;AAED;;;;;;;GAOG;AACH,MAAM,UAAU,OAAO,CAAC,YAA8B,CAAC;IACrD,IAAI,CAAC,SAAS,EAAE,CAAC;QACf,SAAS,GAAG,CAAC,CAAC;IAChB,CAAC;IACD,OAAO,GAAG,CAAC,QAAQ,CAAC,OAAO,EAAE,SAAmB,CAAC,CAAC;AACpD,CAAC;AAED;;;;;;GAMG;AACH,MAAM,UAAU,KAAK;IACnB,OAAO,CAAC,MAAc,EAAE,WAAiB,EAAE,UAAgB,EAAE,EAAE;QAC7D,IAAI,CAAC,UAAU;YACb,MAAM,IAAI,KAAK,CAAC,6CAA6C,CAAC,CAAC;QACjE,IAAI,UAAU,EAAE,YAAY,EAAE,CAAC;YAC7B,UAAU,CAAC,YAAY,GAAG,KAAK,CAAC;QAClC,CAAC;QACD,OAAO,UAAU,CAAC;IACpB,CAAC,CAAC;AACJ,CAAC"}

package/lib/esm/environment.d.ts

@@ -1,7 +1,7 @@
 import { ObjectAccumulator } from "typed-object-accumulator";
 /**
- * @description Factory type for creating Environment instances.
- * @summary Describes factories that construct {@link Environment} derivatives with custom initialization.
+ * @description A factory type for creating Environment instances.
+ * @summary This describes factories that construct {@link Environment} derivatives with custom initialization.
  * @template T - The type of object the Environment will accumulate.
  * @template E - The specific Environment type to be created, extending Environment<T>.
  * @typedef {function(unknown[]): E} EnvironmentFactory
@@ -33,72 +33,71 @@ export declare class Environment<T extends object> extends ObjectAccumulator<T>
     protected constructor();
     /**
      * @description Retrieves a value from the runtime environment.
-     * @summary Handles browser and Node.js environments by normalizing keys and parsing values.
-     * @param {string} k - Key to resolve from the environment.
-     * @return {unknown} Value resolved from the environment or `undefined` when absent.
+     * @summary This method handles browser and Node.js environments by normalizing keys and parsing values.
+     * @param {string} k - The key to resolve from the environment.
+     * @return {unknown} The value that is resolved from the environment, or `undefined` if it is absent.
      */
     protected fromEnv(k: string): unknown;
     /**
      * @description Converts stringified environment values into native types.
-     * @summary Interprets booleans and numbers while leaving other types unchanged.
-     * @param {unknown} val - Raw value retrieved from the environment.
-     * @return {unknown} Parsed value converted to boolean, number, or left as-is.
+     * @summary This method interprets booleans and numbers, while leaving other types unchanged.
+     * @param {unknown} val - The raw value that is retrieved from the environment.
+     * @return {unknown} The parsed value, converted to a boolean or number, or left as-is.
      */
     protected parseEnvValue(val: unknown): unknown;
     /**
      * @description Expands an object into the environment.
-     * @summary Defines lazy properties that first consult runtime variables before falling back to seeded values.
-     * @template V - Type of the object being expanded.
-     * @param {V} value - Object to expose through environment getters and setters.
+     * @summary This method defines lazy properties that first consult runtime variables before falling back to seeded values.
+     * @template V - The type of the object being expanded.
+     * @param {V} value - The object to expose through environment getters and setters.
      * @return {void}
      */
     protected expand<V extends object>(value: V): void;
     /**
-     * @description Returns a proxy enforcing required environment variables.
-     * @summary Accessing a property that resolves to `undefined` or an empty string when declared in the model throws an error.
-     * @return {this} Proxy of the environment enforcing required variables.
+     * @description Returns a proxy that enforces required environment variables.
+     * @summary Accessing a property that resolves to `undefined` or an empty string when declared in the model will throw an error.
+     * @return {EnvironmentInstance<any>} A proxy of the environment that enforces required variables.
      */
     orThrow(): EnvironmentInstance<any>;
     /**
      * @protected
      * @static
      * @description Retrieves or creates the singleton instance of the Environment class.
-     * @summary Ensures only one {@link Environment} instance is created, wrapping it in a proxy to compose ENV keys on demand.
+     * @summary This method ensures that only one {@link Environment} instance is created, and wraps it in a proxy to compose ENV keys on demand.
      * @template E
-     * @param {...unknown[]} args - Arguments forwarded to the factory when instantiating the singleton.
-     * @return {E} Singleton environment instance.
+     * @param {...unknown[]} args - Arguments that are forwarded to the factory when instantiating the singleton.
+     * @return {E} The singleton environment instance.
      */
     protected static instance<E extends Environment<any>>(...args: unknown[]): E;
     accumulate<V extends object>(value: V): AccumulatedEnvironment<T & V>;
     /**
      * @static
      * @description Accumulates the given value into the environment.
-     * @summary Adds new properties, hiding raw descriptors to avoid leaking enumeration semantics.
-     * @template T
+     * @summary This method adds new properties and hides raw descriptors to avoid leaking enumeration semantics.
      * @template V
-     * @param {V} value - Object to merge into the environment.
-     * @return {Environment} Updated environment reference.
+     * @param {V} value - The object to merge into the environment.
+     * @return {AccumulatedEnvironment<any>} The updated environment reference.
      */
     static accumulate<V extends object>(value: V): AccumulatedEnvironment<any>;
     /**
      * @description Retrieves a value using a dot-path key from the accumulated environment.
-     * @summary Delegates to the singleton instance to access stored configuration.
-     * @param {string} key - Key to resolve from the environment store.
-     * @return {unknown} Stored value corresponding to the provided key.
+     * @summary This method delegates to the singleton instance to access stored configuration.
+     * @param {string} key - The key to resolve from the environment store.
+     * @return {unknown} The stored value that corresponds to the provided key.
      */
     static get(key: string): any;
     /**
      * @description Builds a proxy that composes environment keys for nested properties.
-     * @summary Allows chained property access to emit uppercase ENV identifiers while honoring existing runtime overrides.
-     * @param {any} current - Seed model segment used when projecting nested structures.
-     * @param {string[]} path - Accumulated path segments leading to the proxy.
-     * @return {any} Proxy that resolves environment values or composes additional proxies for deeper paths.
+     * @summary This allows chained property access to emit uppercase ENV identifiers, while honoring existing runtime overrides.
+     * @param {any} current - The seed model segment to use when projecting nested structures.
+     * @param {string[]} path - The accumulated path segments that lead to the proxy.
+     * @return {any} A proxy that resolves environment values or composes additional proxies for deeper paths.
      */
     private static buildEnvProxy;
     /**
      * @static
      * @description Retrieves the keys of the environment, optionally converting them to ENV format.
-     * @summary Gets all keys in the environment, with an option to format them for environment variables.
+     * @summary This method gets all keys in the environment, with an option to format them for environment variables.
      * @param {boolean} [toEnv=true] - Whether to convert the keys to ENV format.
      * @return {string[]} An array of keys from the environment.
      */
@@ -108,9 +107,9 @@ export declare class Environment<T extends object> extends ObjectAccumulator<T>
     private static missingEnvError;
 }
 /**
- * @description Singleton environment instance seeded with default logging configuration.
- * @summary Combines {@link DefaultLoggingConfig} with runtime environment variables to provide consistent logging defaults across platforms.
- * @const LoggedEnvironment
+ * @description A singleton environment instance that is seeded with the default logging configuration.
+ * @summary This constant combines {@link DefaultLoggingConfig} with runtime environment variables to provide consistent logging defaults across platforms.
+ * @const {AccumulatedEnvironment<any>} LoggedEnvironment
  * @memberOf module:Logging
  */
 export declare const LoggedEnvironment: any;