mirror of
https://github.com/denoland/std.git
synced 2024-11-22 04:59:05 +00:00
71 lines
2.3 KiB
TypeScript
71 lines
2.3 KiB
TypeScript
// Copyright 2018-2024 the Deno authors. All rights reserved. MIT license.
|
|
// This module is browser compatible.
|
|
|
|
import { getLogger } from "./get_logger.ts";
|
|
import type { GenericFunction } from "./logger.ts";
|
|
import "./setup.ts";
|
|
|
|
/**
|
|
* Log at the error level.
|
|
*
|
|
* This function is a pass-through to the default logger's `error` method. By
|
|
* default, the default logger is configured to use {@linkcode console.log} and
|
|
* print in red text.
|
|
*
|
|
* @template T The type of the message to log.
|
|
* @param msg The message to log.
|
|
* @param args Arguments to be formatted into the message.
|
|
* @returns The message that was logged.
|
|
*
|
|
* @example Usage
|
|
* ```ts
|
|
* import { error } from "@std/log/error";
|
|
* import { assertEquals } from "@std/assert/equals";
|
|
*
|
|
* assertEquals(error("This is an error message."), "This is an error message.");
|
|
* // Prints: "ERROR This is an error message."
|
|
*
|
|
* assertEquals(error(() => "This is an error message."), "This is an error message.");
|
|
* // Prints: "ERROR This is an error message."
|
|
* ```
|
|
*/
|
|
export function error<T>(msg: () => T, ...args: unknown[]): T | undefined;
|
|
/**
|
|
* Log at the error level.
|
|
*
|
|
* This function is a pass-through to the default logger's `error` method. By
|
|
* default, the default logger is configured to use {@linkcode console.log} and
|
|
* print in red text.
|
|
*
|
|
* @template T The type of the message to log.
|
|
* @param msg The message to log.
|
|
* @param args Arguments to be formatted into the message.
|
|
* @returns The message that was logged.
|
|
*
|
|
* @example Usage
|
|
* ```ts
|
|
* import { error } from "@std/log/error";
|
|
* import { assertEquals } from "@std/assert/equals";
|
|
*
|
|
* assertEquals(error("This is an error message."), "This is an error message.");
|
|
* // Prints: "ERROR This is an error message."
|
|
*
|
|
* assertEquals(error(() => "This is an error message."), "This is an error message.");
|
|
* // Prints: "ERROR This is an error message."
|
|
* ```
|
|
*/
|
|
export function error<T>(
|
|
msg: T extends GenericFunction ? never : T,
|
|
...args: unknown[]
|
|
): T;
|
|
export function error<T>(
|
|
msg: (T extends GenericFunction ? never : T) | (() => T),
|
|
...args: unknown[]
|
|
): T | undefined {
|
|
// Assist TS compiler with pass-through generic type
|
|
if (msg instanceof Function) {
|
|
return getLogger("default").error(msg, ...args);
|
|
}
|
|
return getLogger("default").error(msg, ...args);
|
|
}
|