From 3712f89c1d02f9138f2a644c4fbdbc56318a2231 Mon Sep 17 00:00:00 2001 From: Alice Pote Date: Thu, 7 Mar 2024 16:13:22 -0500 Subject: [PATCH] chore(docs): update JSDoc for the `Logger` interface This JSDoc comment is currently outdated because it makes reference to a browser-specific `Logger` impl which we no longer have (it was deleted in #4317). --- src/declarations/stencil-public-compiler.ts | 9 ++++++--- 1 file changed, 6 insertions(+), 3 deletions(-) diff --git a/src/declarations/stencil-public-compiler.ts b/src/declarations/stencil-public-compiler.ts index 2a69e5dbf74..3e4c2c7bbaf 100644 --- a/src/declarations/stencil-public-compiler.ts +++ b/src/declarations/stencil-public-compiler.ts @@ -2054,9 +2054,12 @@ export const LOG_LEVELS = ['debug', 'info', 'warn', 'error'] as const; export type LogLevel = (typeof LOG_LEVELS)[number]; /** - * Common logger to be used by the compiler, dev-server and CLI. The CLI will use a - * NodeJS based console logging and colors, and the web will use browser based - * logs and colors. + * Abstract interface representing a logger with the capability to accept log + * messages at various levels (debug, info, warn, and error), set colors, log + * time spans, print diagnostic messages, and more. + * + * A Node.js-specific implementation of this interface is used when Stencil is + * building and compiling a project. */ export interface Logger { enableColors: (useColors: boolean) => void;