From c24f7e1a817a82099c34273d487c630e7ccfafea Mon Sep 17 00:00:00 2001
From: Eugene Terehov <opensource@terehov.de>
Date: Tue, 8 Aug 2023 12:46:16 +0200
Subject: [PATCH] Fix docs, fix #256

---
 README.md      | 3 ++-
 docs/README.md | 3 ++-
 2 files changed, 4 insertions(+), 2 deletions(-)

diff --git a/README.md b/README.md
index fabb24c..3949d1f 100644
--- a/README.md
+++ b/README.md
@@ -250,8 +250,9 @@ export class CustomLogger<LogObj> extends BaseLogger<LogObj> {
   /**
    * Logs a _CUSTOM_ message.
    * @param args  - Multiple log attributes that should be logged.
+   * @return LogObject with meta property, when log level is >= minLevel
    */
-  public custom(...args: unknown[]): LogObj & ILogObjMeta {
+  public custom(...args: unknown[]): LogObj & ILogObjMeta | undefined {
     return super.log(8, "CUSTOM", ...args);
   }
 
diff --git a/docs/README.md b/docs/README.md
index fabb24c..3949d1f 100644
--- a/docs/README.md
+++ b/docs/README.md
@@ -250,8 +250,9 @@ export class CustomLogger<LogObj> extends BaseLogger<LogObj> {
   /**
    * Logs a _CUSTOM_ message.
    * @param args  - Multiple log attributes that should be logged.
+   * @return LogObject with meta property, when log level is >= minLevel
    */
-  public custom(...args: unknown[]): LogObj & ILogObjMeta {
+  public custom(...args: unknown[]): LogObj & ILogObjMeta | undefined {
     return super.log(8, "CUSTOM", ...args);
   }