From f8c0e5f255b75221e4d9612eb81443827512d0e1 Mon Sep 17 00:00:00 2001
From: Mikael Vesavuori <mikaelvesavuori@gmail.com>
Date: Tue, 14 Feb 2023 16:53:23 +0100
Subject: [PATCH] fix(): add missing description comment for enrichNext()

---
 package-lock.json        |  4 ++--
 package.json             |  2 +-
 src/entities/MikroLog.ts | 14 +++++++++++++-
 3 files changed, 16 insertions(+), 4 deletions(-)

diff --git a/package-lock.json b/package-lock.json
index fed5ea2..9c81081 100644
--- a/package-lock.json
+++ b/package-lock.json
@@ -1,12 +1,12 @@
 {
   "name": "mikrolog",
-  "version": "2.1.13",
+  "version": "2.1.14",
   "lockfileVersion": 2,
   "requires": true,
   "packages": {
     "": {
       "name": "mikrolog",
-      "version": "2.1.13",
+      "version": "2.1.14",
       "license": "MIT",
       "dependencies": {
         "aws-metadata-utils": "1"
diff --git a/package.json b/package.json
index 22a426d..5daca1f 100644
--- a/package.json
+++ b/package.json
@@ -1,7 +1,7 @@
 {
   "name": "mikrolog",
   "description": "The JSON logger you always wanted for Lambda.",
-  "version": "2.1.13",
+  "version": "2.1.14",
   "author": "Mikael Vesavuori",
   "license": "MIT",
   "main": "./lib/index.js",
diff --git a/src/entities/MikroLog.ts b/src/entities/MikroLog.ts
index 3c72e76..6839d0f 100644
--- a/src/entities/MikroLog.ts
+++ b/src/entities/MikroLog.ts
@@ -108,7 +108,19 @@ export class MikroLog {
   }
 
   /**
-   * @description TODO
+   * @description If you want a one-time root-level enrichment, you can do:
+   *
+   * ```
+   * const logger = MikroLog.start();
+   * logger.enrichNext({ someId: '123456789abcdefghi' });
+   * logger.info('Ping!'); // Enrichment is present on log
+   * logger.info('Ping!'); // Enrichment is longer present
+   * ```
+   *
+   * You can also use nested objects:
+   * ```
+   * logger.enrichNext({ myObject: { myValue: 'Something here', otherValue: 'Something else' } });
+   * ```
    */
   public enrichNext(input: Record<string, any>) {
     this.nextLogEnrichment = input;