Function debug

  • debug<T>(msg, ...args): T | undefined

  • Log at the debug level.

    This function is a pass-through to the default logger's debug method. By default, this function is a no-op. To enable debug logging, set call setup and set the default level to DEBUG.

    Type Parameters

    • T

      The type of the message to log.

    Parameters

    • msg: (() => T)

      The message to log.

        • (): T

        • Returns T

    • Rest...args: unknown[]

      Arguments to be formatted into the message.

    Returns T | undefined

    The message that was logged.

    Example: Usage without setup

    import { debug } from "@std/log/debug";
    import { assertEquals } from "@std/assert/equals";

    assertEquals(debug("This is a debug message."), "This is a debug message.");
    // Prints: ""

    assertEquals(debug(() => "This is a debug message."), undefined);
    // Prints: ""

    Example: Usage with setup

    import { ConsoleHandler, debug, setup } from "@std/log";
    import { assertEquals } from "@std/assert/equals";

    setup({
      handlers: {
        default: new ConsoleHandler("DEBUG"),
      },
      loggers: {
        default: {
          level: "DEBUG",
          handlers: ["default"],
        },
      },
    });

    assertEquals(debug("This is a debug message."), "This is a debug message.");

    assertEquals(
      debug(() => "This is a debug message."),
      "This is a debug message.",
    );
  • debug<T>(msg, ...args): T

  • Log at the debug level.

    This function is a pass-through to the default logger's debug method. By default, this function is a no-op. To enable debug logging, set call setup and set the default level to DEBUG.

    Type Parameters

    • T

      The type of the message to log.

    Parameters

    • msg: T extends GenericFunction
          ? never
          : T

      The message to log.

    • Rest...args: unknown[]

      Arguments to be formatted into the message.

    Returns T

    The message that was logged.

    Example: Usage without setup

    import { debug } from "@std/log/debug";
    import { assertEquals } from "@std/assert/equals";

    assertEquals(debug("This is a debug message."), "This is a debug message.");
    // Prints: ""

    assertEquals(debug(() => "This is a debug message."), undefined);
    // Prints: ""

    Example: Usage with setup

    import { ConsoleHandler, debug, setup } from "@std/log";
    import { assertEquals } from "@std/assert/equals";

    setup({
      handlers: {
        default: new ConsoleHandler("DEBUG"),
      },
      loggers: {
        default: {
          level: "DEBUG",
          handlers: ["default"],
        },
      },
    });

    assertEquals(debug("This is a debug message."), "This is a debug message.");

    assertEquals(
      debug(() => "This is a debug message."),
      "This is a debug message.",
    );

Settings

Member Visibility