deprecation(log): string type for BaseHandler.formatter (#4023)

Co-authored-by: Asher Gomez <ashersaupingomez@gmail.com>
denoland · Dec 30, 2023 · c3da971 · c3da971
1 parent 27c3c02
commit c3da971
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 3 deletions.
diff --git a/log/handlers.ts b/log/handlers.ts
@@ -16,6 +16,9 @@ export interface HandlerOptions {
 export class BaseHandler {
   level: number;
   levelName: LevelName;
+  /**
+   * @deprecated (will be removed in 0.213.0) Use {@linkcode FormatterFunction} instead of a string.
+   */
   formatter: string | FormatterFunction;
 
   constructor(levelName: LevelName, options: HandlerOptions = {}) {

diff --git a/log/mod.ts b/log/mod.ts
@@ -151,7 +151,7 @@
  *     file: new log.handlers.FileHandler("WARNING", {
  *       filename: "./log.txt",
  *       // you can change format of output message using any keys in `LogRecord`.
- *       formatter: "{levelName} {msg}",
+ *       formatter: (record) => `${record.levelName} ${record.msg}`,
  *     }),
  *   },
  *
@@ -196,7 +196,7 @@
  * log.setup({
  *   handlers: {
  *     stringFmt: new log.handlers.ConsoleHandler("DEBUG", {
- *       formatter: "[{levelName}] {msg}",
+ *       formatter: (record) => `[${record.levelName}] ${record.msg}`,
  *     }),
  *
  *     functionFmt: new log.handlers.ConsoleHandler("DEBUG", {
@@ -212,7 +212,7 @@
  *     }),
  *
  *     anotherFmt: new log.handlers.ConsoleHandler("DEBUG", {
- *       formatter: "[{loggerName}] - {levelName} {msg}",
+ *       formatter: (record) => `[${record.loggerName}] - ${record.levelName} ${record.msg}`,
  *     }),
  *   },
  *