Added type declaration for custom prettifiers (#207)

pinojs · Jul 16, 2021 · b32ffb5 · b32ffb5
1 parent 35108d9
commit b32ffb5
Show file tree

Hide file tree

Showing 2 changed files with 31 additions and 0 deletions.
diff --git a/index.d.ts b/index.d.ts
@@ -99,6 +99,27 @@ interface PrettyOptions_ {
    * @example "time,hostname"
    */
   ignore?: string;
+  /**
+   * Provides the ability to add a custom prettify function for specific log properties.
+   * `customPrettifiers` is an object, where keys are log properties that will be prettified
+   * and value is the prettify function itself.
+   * For example, if a log line contains a query property, you can specify a prettifier for it:
+   * @default {}
+   *
+   * @example
+   * ```typescript
+   * {
+   *   customPrettifiers: {
+   *     query: prettifyQuery
+   *   }
+   * }
+   * //...
+   * const prettifyQuery = value => {
+   *  // do some prettify magic
+   * }
+   * ```
+   */
+  customPrettifiers?: Record<string, PinoPretty.Prettifier>;
 }
 
 declare namespace PinoPretty {

diff --git a/test/types/pino-pretty.test-d.ts b/test/types/pino-pretty.test-d.ts
@@ -24,6 +24,11 @@ const options: PinoPretty.PrettyOptions = {
   translateTime: "UTC:h:MM:ss TT Z",
   search: "foo == `bar`",
   singleLine: false,
+  customPrettifiers: {
+    key: (value) => {
+      return value.toString().toUpperCase();
+    }
+  }
 };
 
 const options2: PrettyOptions = {
@@ -42,6 +47,11 @@ const options2: PrettyOptions = {
   translateTime: "UTC:h:MM:ss TT Z",
   search: "foo == `bar`",
   singleLine: false,
+  customPrettifiers: {
+    key: (value) => {
+      return value.toString().toUpperCase();
+    }
+  }
 };
 
 const pretty = prettyFactory(options);