Support unknown, reverts 1783, add tests (#1866)

* Revert "fix: typescript types (#1783)" This reverts commit 7f739d3. * Add check Signed-off-by: Matteo Collina <[email protected]> * fixup Signed-off-by: Matteo Collina <[email protected]> --------- Signed-off-by: Matteo Collina <[email protected]>
pinojs · Dec 14, 2023 · 6b470c1 · 6b470c1
1 parent dd9bc64
commit 6b470c1
Show file tree

Hide file tree

Showing 6 changed files with 38 additions and 302 deletions.
diff --git a/README.md b/README.md
@@ -1,7 +1,6 @@
 ![banner](pino-banner.png)
 
 # pino
-
 [![npm version](https://img.shields.io/npm/v/pino)](https://www.npmjs.com/package/pino)
 [![Build Status](https://img.shields.io/github/actions/workflow/status/pinojs/pino/ci.yml)](https://github.com/pinojs/pino/actions)
 [![js-standard-style](https://img.shields.io/badge/code%20style-standard-brightgreen.svg?style=flat)](https://standardjs.com/)
@@ -10,28 +9,18 @@
 
 ## Documentation
 
-* [Readme](/)
-* [API](/docs/api.md)
-* [Browser API](/docs/browser.md)
-* [Redaction](/docs/redaction.md)
-* [Child Loggers](/docs/child-loggers.md)
-* [Transports](/docs/transports.md)
-* [Web Frameworks](/docs/web.md)
-* [Pretty Printing](/docs/pretty.md)
-* [Asynchronous Logging](/docs/asynchronous.md)
-* [Usage With TypeScript](/docs/typescript.md)
-* [Ecosystem](/docs/ecosystem.md)
-* [Benchmarks](/docs/benchmarks.md)
-* [Long Term Support](/docs/lts.md)
-* [Help](/docs/help.md)
- * [Log rotation](/docs/help.md#rotate)
- * [Reopening log files](/docs/help.md#reopening)
- * [Saving to multiple files](/docs/help.md#multiple)
- * [Log filtering](/docs/help.md#filter-logs)
- * [Transports and systemd](/docs/help.md#transport-systemd)
- * [Duplicate keys](/docs/help.md#dupe-keys)
- * [Log levels as labels instead of numbers](/docs/help.md#level-string)
- * [Pino with `debug`](/docs/help.md#debug)
+* [Benchmarks ⇗](/docs/benchmarks.md)
+* [API ⇗](/docs/api.md)
+* [Browser API ⇗](/docs/browser.md)
+* [Redaction ⇗](/docs/redaction.md)
+* [Child Loggers ⇗](/docs/child-loggers.md)
+* [Transports ⇗](/docs/transports.md)
+* [Web Frameworks ⇗](/docs/web.md)
+* [Pretty Printing ⇗](/docs/pretty.md)
+* [Asynchronous Logging ⇗](/docs/asynchronous.md)
+* [Ecosystem ⇗](/docs/ecosystem.md)
+* [Help ⇗](/docs/help.md)
+* [Long Term Support Policy ⇗](/docs/lts.md)
 
 ## Install
 
@@ -75,6 +64,7 @@ For using Pino with a web framework see:
 * [Pino with Node core `http`](docs/web.md#http)
 * [Pino with Nest](docs/web.md#nest)
 
+
 <a name="essentials"></a>
 ## Essentials
 

diff --git a/docs/typescript.md b/docs/typescript.md
diff --git a/docsify/sidebar.md b/docsify/sidebar.md
@@ -7,7 +7,6 @@
 * [Web Frameworks](/docs/web.md)
 * [Pretty Printing](/docs/pretty.md)
 * [Asynchronous Logging](/docs/asynchronous.md)
-* [Usage With TypeScript](/docs/typescript.md)
 * [Ecosystem](/docs/ecosystem.md)
 * [Benchmarks](/docs/benchmarks.md)
 * [Long Term Support](/docs/lts.md)

diff --git a/pino.d.ts b/pino.d.ts
@@ -13,7 +13,6 @@
 // Michel Nemnom <https://github.com/Pegase745>
 // Igor Savin <https://github.com/kibertoad>
 // James Bromwell <https://github.com/thw0rted>
-// Zamiell <https://github.com/Zamiell>
 // TypeScript Version: 4.4
 
 import type { EventEmitter } from "events";
@@ -128,26 +127,6 @@ export interface LoggerExtras<CustomLevels extends string = never> extends Event
  flush(cb?: (err?: Error) => void): void;
 }
 
-/**
- * The valid string interpolation placeholders are documented here:
- * https://getpino.io/#/docs/api?id=logger
- */
-interface StringInterpolationLetterToType {
- s: string;
- d: number;
- o: object;
- O: object;
- j: object;
-}
-
-/** Helper type to extract the string interpolation placeholders and convert them to types. */
-type ExtractArgs<T extends string> = T extends `${string}%${infer R}`
- ? R extends `${infer A}${infer B}`
- ? A extends keyof StringInterpolationLetterToType
- ? [StringInterpolationLetterToType[A], ...ExtractArgs<B>]
- : ExtractArgs<B>
- : ExtractArgs<R>
- : []
 
 declare namespace pino {
  //// Exported types and interfaces
@@ -334,38 +313,11 @@ declare namespace pino {
  }
 
  interface LogFn {
- // The first overload has:
- // - An object as the first argument. (But functions are explicitly disallowed, which count as objects.)
- // - An optional string as the second argument.
- // - N optional arguments after that corresponding to the string interpolation placeholders.
- // e.g.
- // logFn({ foo: "foo" });
- // logFn({ foo: "foo" }, "bar");
- // logFn({ foo: "foo" }, "Message with an interpolation value: %s", "bar");
- // logFn({ foo: "foo" }, "Message with two interpolation values: %s %d", "bar", 123);
- <T extends object, Msg extends string>(
- // We want to disallow functions, which count as the "object" type.
- obj: never extends T ? (T extends Function ? never : T) : T,
- msg?: Msg,
- ...stringInterpolationArgs: ExtractArgs<Msg>
- ): void;
-
- // The second overload has:
- // - A string as the first argument.
- // - N optional arguments after that corresponding to the string interpolation placeholders.
- // e.g.
- // logFn("foo");
- // logFn("Message with an interpolation value: %s", "foo");
- // logFn("Message with two interpolation values: %s %d", "foo", 123);
- <Msg extends string>(msg: Msg, ...stringInterpolationArgs: ExtractArgs<Msg>): void;
-
- // The third overload has:
- // - A `number` or `boolean` as the first argument. (`symbol` is explicitly disallowed.)
- // - No additional arguments should be allowed.
- // e.g.
- // logFn(123);
- // logFn(true);
- (arg: number | boolean): void;
+ // TODO: why is this different from `obj: object` or `obj: any`?
+ /* tslint:disable:no-unnecessary-generics */
+ <T extends object>(obj: T, msg?: string, ...args: any[]): void;
+ (obj: unknown, msg?: string, ...args: any[]): void;
+ (msg: string, ...args: any[]): void;
  }
 
  interface LoggerOptions<CustomLevels extends string = never> {

diff --git a/test/types/pino-arguments.test-d.ts b/test/types/pino-arguments.test-d.ts