Skip to content

feat: enhance type checking for OptionalLogger methods #41

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

Merged
arv merged 2 commits into from
Jun 23, 2026
Merged

feat: enhance type checking for OptionalLogger methods #41

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
81369e6
feat: enhance type checking for OptionalLogger methods
arv Jun 23, 2026
bb8b2d6
Merge branch 'main' into arv/type-check
arv Jun 23, 2026
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
13 changes: 13 additions & 0 deletions src/logger.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -411,3 +411,16 @@ function testNormalizeError(stringifiedError: string) {
name: 'TypeError',
});
}

test.skip('type checking', () => {
expect(true).toBe(true);

const lc = new OptionalLoggerImpl(consoleLogSink, 'debug', {foo: 'bar'});
const {debug} = lc;

// @ts-expect-error Should not allow extracted method.
debug?.('a');

// OK
debug?.call(lc, 'a');
});
Comment thread
arv marked this conversation as resolved.
38 changes: 28 additions & 10 deletions src/logger.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,11 +11,19 @@ export interface OptionalLogger<
Info extends unknown[] = unknown[],
Debug extends unknown[] = unknown[],
> {
error?: ((...args: Error) => void) | undefined;
info?: ((...args: Info) => void) | undefined;
warn?: ((...args: Warn) => void) | undefined;
debug?: ((...args: Debug) => void) | undefined;
flush?: (() => Promise<void>) | undefined;
error?:
| ((this: OptionalLogger<Error, Warn, Info, Debug>, ...args: Error) => void)
| undefined;
info?:
| ((this: OptionalLogger<Error, Warn, Info, Debug>, ...args: Info) => void)
| undefined;
warn?:
| ((this: OptionalLogger<Error, Warn, Info, Debug>, ...args: Warn) => void)
| undefined;
debug?:
| ((this: OptionalLogger<Error, Warn, Info, Debug>, ...args: Debug) => void)
| undefined;
flush?(this: OptionalLogger<Error, Warn, Info, Debug>): Promise<void>;
Comment thread
arv marked this conversation as resolved.
}

/**
Expand Down Expand Up @@ -82,11 +90,21 @@ export class OptionalLoggerImpl<
Info extends unknown[] = unknown[],
Debug extends unknown[] = unknown[],
> implements OptionalLogger<Error, Warn, Info, Debug> {
readonly debug?: ((...args: Debug) => void) | undefined = undefined;
readonly info?: ((...args: Info) => void) | undefined = undefined;
readonly warn?: ((...args: Warn) => void) | undefined = undefined;
readonly error?: ((...args: Error) => void) | undefined = undefined;
readonly flush: () => Promise<void>;
readonly debug?:
| ((this: OptionalLogger<Error, Warn, Info, Debug>, ...args: Debug) => void)
| undefined = undefined;
readonly info?:
| ((this: OptionalLogger<Error, Warn, Info, Debug>, ...args: Info) => void)
| undefined = undefined;
readonly warn?:
| ((this: OptionalLogger<Error, Warn, Info, Debug>, ...args: Warn) => void)
| undefined = undefined;
readonly error?:
| ((this: OptionalLogger<Error, Warn, Info, Debug>, ...args: Error) => void)
| undefined = undefined;
readonly flush: (
this: OptionalLogger<Error, Warn, Info, Debug>,
) => Promise<void>;
Comment on lines +93 to +107

readonly #logSink: LogSink<Error, Warn, Info, Debug>;
readonly #context: Context | undefined;
Expand Down