Skip to content

fix: allow object type in %s placeholder #2277

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
merged 2 commits into from
Sep 10, 2025
Merged

fix: allow object type in %s placeholder #2277

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
c93eecc
fix: allow object type in %s placeholder
mcollina Sep 5, 2025
e2bfc96
fixup
mcollina Sep 10, 2025
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
4 changes: 2 additions & 2 deletions pino.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -326,7 +326,7 @@ declare namespace pino {
type PlaceholderTypeMapping<T extends PlaceholderSpecifier> = T extends 'd'
? number
: T extends 's'
? string | number | boolean | bigint | null | undefined | symbol
? string | number | boolean | bigint | null | undefined | symbol | object
: T extends 'j' | 'o' | 'O'
? object
: never;
Expand Down Expand Up @@ -878,4 +878,4 @@ declare function pino<CustomLevels extends string = never, UseOnlyCustomLevels e
*/
declare function pino<CustomLevels extends string = never, UseOnlyCustomLevels extends boolean = boolean>(options: pino.LoggerOptions<CustomLevels, UseOnlyCustomLevels>, stream?: pino.DestinationStream | undefined): pino.Logger<CustomLevels, UseOnlyCustomLevels>;

export = pino;
export = pino;
5 changes: 3 additions & 2 deletions test/types/pino.test-d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -71,8 +71,9 @@ info({ a: 1, b: '2' }, 'hello world with %s', 'extra data');
// Extra message after placeholder
expectError(info({ a: 1, b: '2' }, 'hello world with %d', 2, 'extra' ));

// metadata with messages type errors
expectError(info({ a: 1, b: '2' }, 'hello world with %s', {}));
// metadata with messages type passes, because of custom toString method
// We can't detect if the object has a custom toString method that returns a string
info({ a: 1, b: '2' }, 'hello world with %s', {});

// metadata after message
expectError(info('message', { a: 1, b: '2' }));
Expand Down
Loading