Skip to content

Remove handleExceptions/handleRejections from LoggerOptions types #2642

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
hxperl wants to merge 1 commit into
base: master
Choose a base branch
from
+15 −2
Open

Remove handleExceptions/handleRejections from LoggerOptions types #2642

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 0 additions & 2 deletions index.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -89,8 +89,6 @@ declare namespace winston {
exitOnError?: Function | boolean;
defaultMeta?: any;
transports?: Transport[] | Transport;
handleExceptions?: boolean;
handleRejections?: boolean;
exceptionHandlers?: any;
rejectionHandlers?: any;
}
Expand Down
15 changes: 15 additions & 0 deletions test/typescript-definitions.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -57,3 +57,18 @@ logger.isInfoEnabled();
logger.isVerboseEnabled();
logger.isDebugEnabled();
logger.isSillyEnabled();

// `handleExceptions` / `handleRejections` are transport options, not logger
// options: `Logger#configure` never reads them off the options object, so
// accepting them here silently did nothing. They belong on a transport.
winston.createLogger({
transports: [
new winston.transports.Console({ handleExceptions: true, handleRejections: true }),
],
});

// @ts-expect-error handleExceptions is not a LoggerOptions field
winston.createLogger({ handleExceptions: true });

// @ts-expect-error handleRejections is not a LoggerOptions field
winston.createLogger({ handleRejections: true });