#518·theatre

Documentation: Add TSDoc comments to ILogger interface

Author: Bitshifter-9Created Nov 26, 2025Updated Nov 26, 2025

The ILogger interface in packages/utils/src/_logger/logger.ts is currently missing documentation for its methods, specifically named, lazy, and utilFor. There is a TODO comment in the code (TODO document these fns) indicating that this needs to be addressed.

How to solve

Add TSDoc comments to the ILogger interface in packages/utils/src/_logger/logger.ts to explain the purpose and usage of its methods:

  1. named(name: string, key?: string | number): Explain that this method creates a named child logger. Document the name parameter (name of the child logger) and the optional key parameter (used to distinguish between multiple loggers with the same name).
  2. lazy: Explain that this property provides lazy logging functions where the log arguments are computed only if the corresponding log level is enabled.
  3. utilFor: Explain that this property provides utility loggers tailored for specific audiences (internal, dev, and public).

i can fix these