feat: add JSON Show instance

thewilkybarkid · Jan 19, 2023 · 8e19bcb · 8e19bcb
1 parent d85f040
commit 8e19bcb
Show file tree

Hide file tree

Showing 3 changed files with 32 additions and 0 deletions.
diff --git a/docs/modules/index.ts.md b/docs/modules/index.ts.md
@@ -19,6 +19,7 @@ Added in v0.1.0
   - [match](#match)
 - [instances](#instances)
   - [EqLogEntry](#eqlogentry)
+  - [JsonShowLogEntry](#jsonshowlogentry)
   - [ShowLogEntry](#showlogentry)
   - [debug](#debug)
   - [debugP](#debugp)
@@ -98,6 +99,16 @@ export declare const EqLogEntry: E.Eq<LogEntry>
 
 Added in v0.1.2
 
+## JsonShowLogEntry
+
+**Signature**
+
+```ts
+export declare const JsonShowLogEntry: S.Show<LogEntry>
+```
+
+Added in v0.2.2
+
 ## ShowLogEntry
 
 **Signature**

diff --git a/src/index.ts b/src/index.ts
@@ -135,6 +135,14 @@ export const ShowLogEntry: Show<LogEntry> = {
     }`,
 }
 
+/**
+ * @category instances
+ * @since 0.2.2
+ */
+export const JsonShowLogEntry: Show<LogEntry> = {
+  show: safeStringify,
+}
+
 /**
  * Colorizes log entries based on the level.
  *

diff --git a/test/index.test.ts b/test/index.test.ts
@@ -81,6 +81,19 @@ describe('logger-fp-ts', () => {
       })
     })
 
+    test('JsonShowLogEntry', () => {
+      fc.assert(
+        fc.property(fc.logEntry(), logEntry => {
+          expect(JSON.parse(_.JsonShowLogEntry.show(logEntry))).toStrictEqual({
+            date: logEntry.date.toISOString(),
+            level: logEntry.level,
+            message: logEntry.message,
+            payload: logEntry.payload,
+          })
+        }),
+      )
+    })
+
     describe('getColoredShow', () => {
       test('with a DEBUG', () => {
         fc.assert(