feat: Relax isLogOptions validation to ignore unknown properties

FoxxMD · Mar 28, 2024 · 0e24123 · 0e24123
1 parent d38e328
commit 0e24123
Show file tree

Hide file tree

Showing 4 changed files with 9 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": "@foxxmd/logging",
   "type": "module",
-  "version": "0.1.13",
+  "version": "0.1.14",
   "repository": "https://github.com/foxxmd/logging",
   "description": "A typed, opinionated, batteries-included, Pino-based logging solution for backend TS/JS projects",
   "scripts": {

diff --git a/src/funcs.ts b/src/funcs.ts
@@ -13,7 +13,7 @@ import {isAbsolute, resolve} from 'node:path';
 
 export const isLogOptions = (obj: object = {}): obj is LogOptions => {
     return Object.entries(obj).every(([key, val]) => {
-        if (val === undefined) {
+        if (val === undefined || !['file','console','level'].includes(key)) {
             return true;
         }
         const t = typeof val;

diff --git a/tests/index.test.ts b/tests/index.test.ts
@@ -180,6 +180,11 @@ describe('Config Parsing', function () {
         expect(() => parseLogOptions()).to.not.throw;
     })
 
+    it('does not throw when object contains unknown properties', function () {
+        // @ts-expect-error
+        expect(() => parseLogOptions({extraProp: 'test'})).to.not.throw;
+    })
+
     it('does not throw when a valid level is given', function () {
         for (const level of LOG_LEVEL_NAMES) {
             expect(() => parseLogOptions({level})).to.not.throw;