@monochromatic-dev/module-logger 0.2.0 → 0.3.0

package/src/create-logger.ts

@@ -9,41 +9,41 @@ import type {
 } from './types.ts';
 
 /**
- * Default `flush()` deadline in milliseconds. Measured on 2026-09-06: a
- * default logger flushing 100 records through the console and file sinks
- * settles in about 2 ms locally, so this leaves three orders of magnitude for
- * a slow but working backend while still bounding shutdown on a wedged one.
- * Override per logger through the `flushDeadlineMs` option of
- * {@link createLogger}.
+ Default `flush()` deadline in milliseconds. Measured on 2026-09-06: a
+ default logger flushing 100 records through the console and file sinks
+ settles in about 2 ms locally, so this leaves three orders of magnitude for
+ a slow but working backend while still bounding shutdown on a wedged one.
+ Override per logger through the `flushDeadlineMs` option of
+ {@link createLogger}.
  */
 export const DEFAULT_FLUSH_DEADLINE_MS = 5_000;
 
 /**
- * Default per-sink `verify()` time limit in milliseconds. Measured on
- * 2026-09-06: the default logger's five shipped verifies complete together in
- * about 2.4 ms locally, so this leaves three orders of magnitude for a slow
- * but working backend probe (a network filesystem, a busy IndexedDB) while a
- * verify that never answers (a hung mount, an IndexedDB open blocked by
- * another tab) can no longer stall startup. Override per logger through the
- * `verifyTimeoutMs` option of {@link createLogger}.
+ Default per-sink `verify()` time limit in milliseconds. Measured on
+ 2026-09-06: the default logger's five shipped verifies complete together in
+ about 2.4 ms locally, so this leaves three orders of magnitude for a slow
+ but working backend probe (a network filesystem, a busy IndexedDB) while a
+ verify that never answers (a hung mount, an IndexedDB open blocked by
+ another tab) can no longer stall startup. Override per logger through the
+ `verifyTimeoutMs` option of {@link createLogger}.
  */
 export const DEFAULT_VERIFY_TIMEOUT_MS = 5_000;
 
 /**
- * Most records the logger buffers before its sinks have verified. Startup
- * lasts at most {@link DEFAULT_VERIFY_TIMEOUT_MS}, so this bounds the memory a
- * burst during that window can claim; on overflow the oldest buffered record
- * is dropped so the newest (usually most diagnostic) context survives, and
- * one synthetic `warn` record naming the dropped count is written to every
- * available sink once initialization completes.
+ Most records the logger buffers before its sinks have verified. Startup
+ lasts at most {@link DEFAULT_VERIFY_TIMEOUT_MS}, so this bounds the memory a
+ burst during that window can claim; on overflow the oldest buffered record
+ is dropped so the newest (usually most diagnostic) context survives, and
+ one synthetic `warn` record naming the dropped count is written to every
+ available sink once initialization completes.
  */
 export const STARTUP_BUFFER_CAP = 10_000;
 
 /**
- * Sink paired with its current availability inside one logger instance.
- * Availability starts `false` (not-yet-verified reads as unavailable,
- * identical to a verified failure) and flips `true` once the sink's own
- * `verify` confirms its backend.
+ Sink paired with its current availability inside one logger instance.
+ Availability starts `false` (not-yet-verified reads as unavailable,
+ identical to a verified failure) and flips `true` once the sink's own
+ `verify` confirms its backend.
  */
 type SinkEntry = {
   available: boolean;
@@ -51,12 +51,12 @@ type SinkEntry = {
 };
 
 /**
- * Awaits one sink write so `flush()` can observe its settling. A rejected
- * write is swallowed here via {@link reportLoggerInternalError} (the sink
- * owns its own write-error handling) and does not disable the sink: one
- * transient failure must not retire a backend for the rest of the run.
- *
- * @param writePromise - Promise returned by the sink write call.
+ Awaits one sink write so `flush()` can observe its settling. A rejected
+ write is swallowed here via {@link reportLoggerInternalError} (the sink
+ owns its own write-error handling) and does not disable the sink: one
+ transient failure must not retire a backend for the rest of the run.
+ 
+ @param writePromise - Promise returned by the sink write call.
  */
 async function trackWrite(
   { writePromise, }: { readonly writePromise: Promise<void>; },
@@ -73,56 +73,56 @@ async function trackWrite(
 }
 
 /**
- * Builds a multi-sink logger over the supplied sink adapters. All
- * orchestration (per-sink availability, startup buffering and replay,
- * in-flight write tracking, and flush) lives here; the exported default
- * `logger` is just this factory applied to the default sink set, and tests
- * apply it to fake sinks to exercise the orchestration directly.
- *
- * Verification runs eagerly at construction and never blocks callers:
- * records emitted while an async sink is still verifying buffer internally
- * and replay to that sink the moment it verifies. Every sink verifies
- * concurrently under its own time limit (`verifyTimeoutMs`, default
- * {@link DEFAULT_VERIFY_TIMEOUT_MS}), so one backend that never answers
- * cannot starve the others or keep the logger from initializing. A sink
- * whose `verify` resolves `false`, throws, or runs past the limit is dropped
- * and receives no records; an answer that arrives after the limit is
- * ignored. A rejected `write` is the sink's own concern and does not disable
- * the backend.
- *
- * `flush()` always resolves: one deadline (`flushDeadlineMs`, default
- * {@link DEFAULT_FLUSH_DEADLINE_MS}) wraps startup verification, the
- * in-flight write drain, and every sink flush hook together. When it elapses
- * the logger reports one breadcrumb, abandons the tracked writes from its
- * view (the sinks expose no cancellation, so the underlying work continues),
- * and resolves, so a wedged backend cannot hang a shutdown.
- *
- * @param sinks - Sink adapters to fan each record out to, in priority order.
- *
- * @param flushDeadlineMs - Milliseconds one `flush()` may take before it
- * resolves anyway; raise it for slow but working backends such as network
- * filesystems.
- *
- * @param verifyTimeoutMs - Milliseconds one sink's `verify()` may take before
- * the sink counts as unavailable; raise it for a slow but working probe.
- *
- * @returns Logger plus its eager `initPromise`; callers need not await
- * `initPromise` before logging, since startup records replay on verify.
- *
- * @example
- * ```ts
- * const { logger } = createLogger({ sinks: [createConsoleSink()] });
- * logger.info('ready');
- * await logger.flush();
- * ```
- *
- * @example
- * ```ts
- * const { logger } = createLogger({
- *   sinks: [createFileSink()],
- *   flushDeadlineMs: 30_000,
- * });
- * ```
+ Builds a multi-sink logger over the supplied sink adapters. All
+ orchestration (per-sink availability, startup buffering and replay,
+ in-flight write tracking, and flush) lives here; the exported default
+ `logger` is just this factory applied to the default sink set, and tests
+ apply it to fake sinks to exercise the orchestration directly.
+ 
+ Verification runs eagerly at construction and never blocks callers:
+ records emitted while an async sink is still verifying buffer internally
+ and replay to that sink the moment it verifies. Every sink verifies
+ concurrently under its own time limit (`verifyTimeoutMs`, default
+ {@link DEFAULT_VERIFY_TIMEOUT_MS}), so one backend that never answers
+ cannot starve the others or keep the logger from initializing. A sink
+ whose `verify` resolves `false`, throws, or runs past the limit is dropped
+ and receives no records; an answer that arrives after the limit is
+ ignored. A rejected `write` is the sink's own concern and does not disable
+ the backend.
+ 
+ `flush()` always resolves: one deadline (`flushDeadlineMs`, default
+ {@link DEFAULT_FLUSH_DEADLINE_MS}) wraps startup verification, the
+ in-flight write drain, and every sink flush hook together. When it elapses
+ the logger reports one breadcrumb, abandons the tracked writes from its
+ view (the sinks expose no cancellation, so the underlying work continues),
+ and resolves, so a wedged backend cannot hang a shutdown.
+ 
+ @param sinks - Sink adapters to fan each record out to, in priority order.
+ 
+ @param flushDeadlineMs - Milliseconds one `flush()` may take before it
+ resolves anyway; raise it for slow but working backends such as network
+ filesystems.
+ 
+ @param verifyTimeoutMs - Milliseconds one sink's `verify()` may take before
+ the sink counts as unavailable; raise it for a slow but working probe.
+ 
+ @returns Logger plus its eager `initPromise`; callers need not await
+ `initPromise` before logging, since startup records replay on verify.
+ 
+ @example
+ ```ts
+ const { logger } = createLogger({ sinks: [createConsoleSink()] });
+ logger.info('ready');
+ await logger.flush();
+ ```
+ 
+ @example
+ ```ts
+ const { logger } = createLogger({
+   sinks: [createFileSink()],
+   flushDeadlineMs: 30_000,
+ });
+ ```
  */
 export function createLogger(
   {
@@ -139,7 +139,7 @@ export function createLogger(
   readonly logger: Logger;
 } {
   /**
-   * Per-sink availability for this logger instance, indexed by startup order.
+   Per-sink availability for this logger instance, indexed by startup order.
    */
   const entries: SinkEntry[] = sinks.map(function toEntry(sink,): SinkEntry {
     return {
@@ -149,26 +149,26 @@ export function createLogger(
   },);
 
   /**
-   * Log records emitted before every sink has completed startup verification.
-   * Records stay here only during initialization; each sink that later
-   * verifies as available receives a replay, while already-available sinks
-   * still receive writes immediately.
+   Log records emitted before every sink has completed startup verification.
+   Records stay here only during initialization; each sink that later
+   verifies as available receives a replay, while already-available sinks
+   still receive writes immediately.
    */
   const startupRecords: LogRecord[] = [];
 
   /**
-   * Sink writes currently in flight. Logger-level `flush()` drains these so
-   * sinks without their own flush hook, such as file writes, still settle
-   * before the flush resolves.
+   Sink writes currently in flight. Logger-level `flush()` drains these so
+   sinks without their own flush hook, such as file writes, still settle
+   before the flush resolves.
    */
   const pendingWrites = new Set<Promise<void>>();
 
   /**
-   * Instance-local aggregate flags. `initialized` flips true once the eager
-   * `initialize()` settles; `hasAvailableSink` reflects whether any sink
-   * survives verification and is recomputed by `recomputeAvailability`;
-   * `droppedStartupRecords` counts startup-buffer overflow drops for the
-   * post-initialization marker record.
+   Instance-local aggregate flags. `initialized` flips true once the eager
+   `initialize()` settles; `hasAvailableSink` reflects whether any sink
+   survives verification and is recomputed by `recomputeAvailability`;
+   `droppedStartupRecords` counts startup-buffer overflow drops for the
+   post-initialization marker record.
    */
   const state: {
     droppedStartupRecords: number;
@@ -181,11 +181,11 @@ export function createLogger(
   };
 
   /**
-   * Buffers a pre-initialization record under {@link STARTUP_BUFFER_CAP},
-   * dropping the oldest buffered record (and counting the drop) when the cap
-   * is reached.
-   *
-   * @param record - Record logged before every sink has verified.
+   Buffers a pre-initialization record under {@link STARTUP_BUFFER_CAP},
+   dropping the oldest buffered record (and counting the drop) when the cap
+   is reached.
+   
+   @param record - Record logged before every sink has verified.
    */
   function bufferStartupRecord({ record, }: { readonly record: LogRecord; },): void {
     if (startupRecords.length >= STARTUP_BUFFER_CAP) {
@@ -196,7 +196,7 @@ export function createLogger(
   }
 
   /**
-   * Recomputes aggregate availability after a sink entry's flag flips.
+   Recomputes aggregate availability after a sink entry's flag flips.
    */
   function recomputeAvailability(): void {
     state.hasAvailableSink = entries.some(function isAvailable(entry,) {
@@ -205,17 +205,17 @@ export function createLogger(
   }
 
   /**
-   * Reads a sink entry by startup-order index.
-   *
-   * @param entryIndex - Sink entry index from the construction-time order.
-   *
-   * @returns Sink entry at that index.
-   *
-   * @throws Error when index no longer maps to a sink entry.
+   Reads a sink entry by startup-order index.
+   
+   @param entryIndex - Sink entry index from the construction-time order.
+   
+   @returns Sink entry at that index.
+   
+   @throws Error when index no longer maps to a sink entry.
    */
   function getSinkEntry({ entryIndex, }: { readonly entryIndex: number; },): SinkEntry {
     /**
-     * Sink entry read from startup-order storage; undefined means the caller supplied an invalid index.
+     Sink entry read from startup-order storage; undefined means the caller supplied an invalid index.
      */
     const entry = entries[entryIndex];
     if (entry === undefined)
@@ -225,15 +225,15 @@ export function createLogger(
   }
 
   /**
-   * Marks a sink unavailable after its verification fails or throws. Write
-   * failures never reach here: a rejected write is the sink's own concern and
-   * leaves the backend available, so one transient hiccup does not retire it.
-   *
-   * @param entryIndex - Sink entry index whose backend failed verification.
+   Marks a sink unavailable after its verification fails or throws. Write
+   failures never reach here: a rejected write is the sink's own concern and
+   leaves the backend available, so one transient hiccup does not retire it.
+   
+   @param entryIndex - Sink entry index whose backend failed verification.
    */
   function markEntryUnavailable({ entryIndex, }: { readonly entryIndex: number; },): void {
     /**
-     * Mutable sink entry being disabled.
+     Mutable sink entry being disabled.
      */
     const entry = getSinkEntry({ entryIndex, },);
     entry.available = false;
@@ -241,9 +241,9 @@ export function createLogger(
   }
 
   /**
-   * Removes a tracked sink write from {@link pendingWrites} once it settles.
-   *
-   * @param trackedWrite - Promise returned by {@link trackWrite}.
+   Removes a tracked sink write from {@link pendingWrites} once it settles.
+   
+   @param trackedWrite - Promise returned by {@link trackWrite}.
    */
   async function removePendingWriteWhenSettled(
     { trackedWrite, }: { readonly trackedWrite: Promise<void>; },
@@ -253,11 +253,11 @@ export function createLogger(
   }
 
   /**
-   * Sends a record to one sink, recording the write so `flush()` can await it.
-   *
-   * @param entryIndex - Available sink entry index to receive the record.
-   *
-   * @param record - Log record to deliver.
+   Sends a record to one sink, recording the write so `flush()` can await it.
+   
+   @param entryIndex - Available sink entry index to receive the record.
+   
+   @param record - Log record to deliver.
    */
   function writeRecordToEntry(
     {
@@ -270,11 +270,11 @@ export function createLogger(
   ): void {
     try {
       /**
-       * Sink entry receiving the record.
+       Sink entry receiving the record.
        */
       const entry = getSinkEntry({ entryIndex, },);
       /**
-       * Monitored sink write; resolves even when the underlying write rejects, because {@link trackWrite} swallows rejection.
+       Monitored sink write; resolves even when the underlying write rejects, because {@link trackWrite} swallows rejection.
        */
       const trackedWrite = trackWrite({
         writePromise: entry.sink
@@ -292,9 +292,9 @@ export function createLogger(
   }
 
   /**
-   * Replays buffered startup records to a sink that just became available.
-   *
-   * @param entryIndex - Newly available sink entry index.
+   Replays buffered startup records to a sink that just became available.
+   
+   @param entryIndex - Newly available sink entry index.
    */
   function replayStartupRecordsToEntry({ entryIndex, }: { readonly entryIndex: number; },): void {
     startupRecords.forEach(function replayStartupRecord(record,) {
@@ -306,12 +306,12 @@ export function createLogger(
   }
 
   /**
-   * Applies a verification result to a sink and replays startup records on
-   * success.
-   *
-   * @param entryIndex - Sink entry index whose verification completed.
-   *
-   * @param available - Whether the backend verified successfully.
+   Applies a verification result to a sink and replays startup records on
+   success.
+   
+   @param entryIndex - Sink entry index whose verification completed.
+   
+   @param available - Whether the backend verified successfully.
    */
   function setEntryAvailability(
     {
@@ -323,7 +323,7 @@ export function createLogger(
     },
   ): void {
     /**
-     * Sink entry whose availability is changing.
+     Sink entry whose availability is changing.
      */
     const entry = getSinkEntry({ entryIndex, },);
     entry.available = available;
@@ -333,18 +333,18 @@ export function createLogger(
   }
 
   /**
-   * Runs one sink's verification under the verify time limit and records the
-   * result, replaying buffered startup records to it on success. A rejected
-   * verification, a synchronous throw from the verifier, or a verify that
-   * runs past `verifyTimeoutMs` drops the sink; a late answer after the limit
-   * is never observed, so it cannot flip availability afterwards.
-   *
-   * @param entryIndex - Sink entry index to verify.
+   Runs one sink's verification under the verify time limit and records the
+   result, replaying buffered startup records to it on success. A rejected
+   verification, a synchronous throw from the verifier, or a verify that
+   runs past `verifyTimeoutMs` drops the sink; a late answer after the limit
+   is never observed, so it cannot flip availability afterwards.
+   
+   @param entryIndex - Sink entry index to verify.
    */
   async function verifyAndApply({ entryIndex, }: { readonly entryIndex: number; },): Promise<void> {
     try {
       /**
-       * Sink entry whose verifier is about to run.
+       Sink entry whose verifier is about to run.
        */
       const entry = getSinkEntry({ entryIndex, },);
       setEntryAvailability({
@@ -367,19 +367,19 @@ export function createLogger(
   }
 
   /**
-   * Writes one synthetic `warn` record to every available sink when the
-   * startup buffer overflowed, so the loss is never silent. Runs once, after
-   * initialization, when the dropped count is known and final.
+   Writes one synthetic `warn` record to every available sink when the
+   startup buffer overflowed, so the loss is never silent. Runs once, after
+   initialization, when the dropped count is known and final.
    */
   function emitDroppedStartupMarker(): void {
     /**
-     * Records dropped from the startup buffer; zero means nothing to report.
+     Records dropped from the startup buffer; zero means nothing to report.
      */
     const dropped = state.droppedStartupRecords;
     if (dropped === 0)
       return;
     /**
-     * Marker record naming the loss; the noun agrees with the count.
+     Marker record naming the loss; the noun agrees with the count.
      */
     const marker: LogRecord = {
       level: 'warn',
@@ -400,14 +400,14 @@ export function createLogger(
   }
 
   /**
-   * Initializes all sink backends by verifying their availability. Runs once
-   * at construction. Every verifier runs concurrently, each under the verify
-   * time limit, so one backend that never answers cannot starve the rest or
-   * keep `initialized` from flipping. Completion order does not affect
-   * correctness: a record's immediate-write set (sinks already available when
-   * it was logged) and its replay set (sinks that become available later) are
-   * disjoint, so each available sink receives each record exactly once
-   * whichever verify settles first.
+   Initializes all sink backends by verifying their availability. Runs once
+   at construction. Every verifier runs concurrently, each under the verify
+   time limit, so one backend that never answers cannot starve the rest or
+   keep `initialized` from flipping. Completion order does not affect
+   correctness: a record's immediate-write set (sinks already available when
+   it was logged) and its replay set (sinks that become available later) are
+   disjoint, so each available sink receives each record exactly once
+   whichever verify settles first.
    */
   async function initialize(): Promise<void> {
     if (state.initialized)
@@ -428,29 +428,29 @@ export function createLogger(
   }
 
   /**
-   * Eager readiness promise. Consumers do not need to await this before
-   * logging; `flush()` awaits it internally, and startup records replay to
-   * async sinks as they become available.
+   Eager readiness promise. Consumers do not need to await this before
+   logging; `flush()` awaits it internally, and startup records replay to
+   async sinks as they become available.
    */
   const initPromise: Promise<void> = initialize();
 
   /**
-   * Drains every currently tracked sink write.
+   Drains every currently tracked sink write.
    */
   async function drainPendingWrites(): Promise<void> {
     /**
-     * Snapshot of tracked writes at flush time.
+     Snapshot of tracked writes at flush time.
      */
     const writes = [...pendingWrites,];
     await Promise.all(writes,);
   }
 
   /**
-   * Creates a logging method for the specified severity level.
-   *
-   * @param level - Log severity level for messages from this method.
-   *
-   * @returns Logging function for the given level.
+   Creates a logging method for the specified severity level.
+   
+   @param level - Log severity level for messages from this method.
+   
+   @returns Logging function for the given level.
    */
   function createMethod(level: Level,): (message: string,) => void {
     return function logAtLevel(message: string,): void {
@@ -459,7 +459,7 @@ export function createLogger(
         throw new Error('No logging backends available',);
 
       /**
-       * Shared LogRecord forwarded to every available sink; built once per call so all sinks see the same timestamp.
+       Shared LogRecord forwarded to every available sink; built once per call so all sinks see the same timestamp.
        */
       const record: LogRecord = {
         level,
@@ -471,7 +471,7 @@ export function createLogger(
         bufferStartupRecord({ record, },);
 
       /**
-       * Indices of sinks that survived verification; recomputed per call so a sink dropped at verify time is excluded next time.
+       Indices of sinks that survived verification; recomputed per call so a sink dropped at verify time is excluded next time.
        */
       const availableIndices = entries
         .map(function indexEntry(
@@ -495,8 +495,8 @@ export function createLogger(
   }
 
   /**
-   * Runs every available sink's own `flush` hook. A rejecting hook marks that
-   * sink unavailable and does not fail the aggregate.
+   Runs every available sink's own `flush` hook. A rejecting hook marks that
+   sink unavailable and does not fail the aggregate.
    */
   async function runSinkFlushHooks(): Promise<void> {
     await Promise.all(
@@ -505,7 +505,7 @@ export function createLogger(
         entryIndex,
       ) {
         /**
-         * Optional sink-supplied flush hook; absent when the sink writes synchronously and needs no draining.
+         Optional sink-supplied flush hook; absent when the sink writes synchronously and needs no draining.
          */
         const sinkFlush = entry.sink
           .flush;
@@ -526,11 +526,11 @@ export function createLogger(
   }
 
   /**
-   * Drains startup verification, in-flight sink writes (via
-   * {@link drainPendingWrites}), and every sink flush hook (via
-   * {@link runSinkFlushHooks}) in order. Never rejects on its own: every
-   * inner failure is already reported and swallowed, so the only way this
-   * stays pending is a verify, write, or hook that never settles.
+   Drains startup verification, in-flight sink writes (via
+   {@link drainPendingWrites}), and every sink flush hook (via
+   {@link runSinkFlushHooks}) in order. Never rejects on its own: every
+   inner failure is already reported and swallowed, so the only way this
+   stays pending is a verify, write, or hook that never settles.
    */
   async function drainEverything(): Promise<void> {
     await initPromise;
@@ -539,21 +539,21 @@ export function createLogger(
   }
 
   /**
-   * Drops every tracked write from the logger's view after the flush deadline
-   * elapsed. The tracked wrappers keep their own rejection handling, so a
-   * late settlement can neither surface as an unhandled rejection nor stall
-   * the next `flush()`. The underlying sink work is not cancelled: sinks
-   * expose no cancellation signal.
+   Drops every tracked write from the logger's view after the flush deadline
+   elapsed. The tracked wrappers keep their own rejection handling, so a
+   late settlement can neither surface as an unhandled rejection nor stall
+   the next `flush()`. The underlying sink work is not cancelled: sinks
+   expose no cancellation signal.
    */
   function abandonPendingWrites(): void {
     pendingWrites.clear();
   }
 
   /**
-   * Runs {@link drainEverything} under the flush deadline. Resolves once all
-   * tracked writes and hooks have settled, or once `flushDeadlineMs` elapses,
-   * whichever comes first; a deadline hit reports one breadcrumb and abandons
-   * the tracked writes so shutdown proceeds.
+   Runs {@link drainEverything} under the flush deadline. Resolves once all
+   tracked writes and hooks have settled, or once `flushDeadlineMs` elapses,
+   whichever comes first; a deadline hit reports one breadcrumb and abandons
+   the tracked writes so shutdown proceeds.
    */
   async function flushAll(): Promise<void> {
     try {
@@ -573,7 +573,7 @@ export function createLogger(
   }
 
   /**
-   * Multi-sink logger that writes to all available backends.
+   Multi-sink logger that writes to all available backends.
    */
   const logger: Logger = {
     debug: createMethod('debug',),