fix(): add missing description comment for enrichNext()

mikaelvesavuori · Feb 14, 2023 · f8c0e5f · f8c0e5f
1 parent 3018b49
commit f8c0e5f
Show file tree

Hide file tree

Showing 3 changed files with 16 additions and 4 deletions.
diff --git a/package-lock.json b/package-lock.json
diff --git 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
@@ -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;