Function warn

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

  • Log at the warning level.

    This function is a pass-through to the default logger's warn method. By default, the default logger is configured to use console.log and print in yellow text.

    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

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

    assertEquals(warn("This is a warning message."), "This is a warning message.");
    // Prints: "WARN This is a warning message."

    assertEquals(warn(() => "This is a warning message."), "This is a warning message.");
    // Prints: "WARN This is a warning message."
  • warn<T>(msg, ...args): T

  • Log at the warning level.

    This function is a pass-through to the default logger's warn method. By default, the default logger is configured to use console.log.

    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

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

    assertEquals(warn("This is a warning message."), "This is a warning message.");
    // Prints: "WARN This is a warning message."

    assertEquals(warn(() => "This is a warning message."), "This is a warning message.");
    // Prints: "WARN This is a warning message."

Settings

Member Visibility