Skip to content

Commit

Permalink
chore(docs): update JSDoc for the Logger interface
Browse files Browse the repository at this point in the history
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).
  • Loading branch information
alicewriteswrongs committed Mar 7, 2024
1 parent b6e6e94 commit 3712f89
Showing 1 changed file with 6 additions and 3 deletions.
9 changes: 6 additions & 3 deletions src/declarations/stencil-public-compiler.ts
Original file line number Diff line number Diff line change
Expand Up @@ -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;
Expand Down

0 comments on commit 3712f89

Please sign in to comment.