From 759c2ec93c87a6b9b9bf28ee7a0887bd6a0ad80b Mon Sep 17 00:00:00 2001
From: Amar Lankri <amar.lankri@algoan.com>
Date: Tue, 5 Dec 2023 18:23:30 +0100
Subject: [PATCH] docs(logging): add docs masking options of logging
 interceptor

---
 packages/logging-interceptor/README.md | 8 ++++++++
 1 file changed, 8 insertions(+)

diff --git a/packages/logging-interceptor/README.md b/packages/logging-interceptor/README.md
index c4226a2e..43c86cd3 100644
--- 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
+              }
+            },
+          },
         }),
     },
   ],