docs(logging): add docs masking options of logging interceptor

algoan · Dec 5, 2023 · 759c2ec · 759c2ec
1 parent 7aa4f48
commit 759c2ec
Showing 1 changed file with 8 additions and 0 deletions.
diff --git a/packages/logging-interceptor/README.md b/packages/logging-interceptor/README.md
@@ -232,6 +232,14 @@ import { LoggingInterceptor } from '@algoan/nestjs-logging-interceptor';
         new LoggingInterceptor({
           disableMasking: true, // Ignore masking options in the entire applications
           maskingPlaceholder: 'hidden', // Replace the default placeholder '****' by a custom one
+          mask: {
+            requestHeader: {
+              password: true, // Mask the header 'password' in the request
+              authorization: (header: string | string[]) => {
+                ... // Handle the header value to keep non sensitve data for instance
+              }
+            },
+          },
         }),
     },
   ],