larvitutils 5.0.14 → 5.1.0

package/LICENSE

@@ -1,4 +1,4 @@
-Copyright 2019 LARV IT AB
+Copyright 2022 LARV IT AB
 
 Permission to use, copy, modify, and/or distribute this software for any purpose with or without fee is hereby granted, provided that the above copyright notice and this permission notice appear in all copies.
 

package/README.md

@@ -175,7 +175,7 @@ This is ment as a very simple replacement for winston
 import { Log } from 'larvitutils';
 const log = new Log();
 
-log.info('Hello'); // prints to stdout "2018-08-08T20:02:34Z [inf] Hello
+log.info('Hello', { foo: 'bar' }); // prints to stdout "2018-08-08T20:02:34Z [inf] Hello {"foo":"bar}
 log.error('Hello'); // prints to stderr "2018-08-08T20:02:48Z [err] Hello
 ```
 

package/dist/index.d.ts

@@ -1,5 +1,5 @@
 /// <reference types="node" />
-import { KeyValues, LogInstance, LogLevel, LogOptions, UniqueKeyValues, UtilsOptions } from './models';
+import { KeyValues, LogInstance, LogLevel, LogOptions, Metadata, UniqueKeyValues, UtilsOptions } from './models';
 declare class Log {
     private readonly validLogLevels;
     private options;
@@ -10,14 +10,15 @@ declare class Log {
      * @param options.level[=process.env.NODE_LOG_LVL] - log level
      */
     constructor(options?: LogOptions | LogLevel);
-    stdout(lvl: string, msg: string): void;
-    stderr(lvl: string, msg: string): void;
-    silly(msg: string): void;
-    debug(msg: string): void;
-    verbose(msg: string): void;
-    info(msg: string): void;
-    warn(msg: string): void;
-    error(msg: string): void;
+    private frmtStr;
+    stdout(lvl: string, msg: string, metadata?: Metadata): void;
+    stderr(lvl: string, msg: string, metadata?: Metadata): void;
+    silly(msg: string, metadata?: Metadata): void;
+    debug(msg: string, metadata?: Metadata): void;
+    verbose(msg: string, metadata?: Metadata): void;
+    info(msg: string, metadata?: Metadata): void;
+    warn(msg: string, metadata?: Metadata): void;
+    error(msg: string, metadata?: Metadata): void;
     private getDefaultLogLevel;
     private optionsIsLogOptions;
     private isLogLevel;

package/dist/index.js

@@ -27,42 +27,49 @@ class Log {
             this.options = { level: defaultLogLevel };
         }
     }
-    stdout(lvl, msg) {
+    frmtStr(lvl, msg, metadata) {
+        let str = `${(new Date()).toISOString().substring(0, 19)}Z [${lvl}] ${msg}`;
+        if (metadata) {
+            str += ` ${JSON.stringify(metadata)}`;
+        }
+        return str;
+    }
+    stdout(lvl, msg, metadata) {
         // tslint:disable-next-line:no-console
-        console.log((new Date()).toISOString().substring(0, 19) + 'Z [' + lvl + '] ' + msg);
+        console.log(this.frmtStr(lvl, msg, metadata));
     }
-    stderr(lvl, msg) {
+    stderr(lvl, msg, metadata) {
         // tslint:disable-next-line:no-console
-        console.error((new Date()).toISOString().substring(0, 19) + 'Z [' + lvl + '] ' + msg);
+        console.error(this.frmtStr(lvl, msg, metadata));
     }
-    silly(msg) {
+    silly(msg, metadata) {
         if (this.options.level === 'silly') {
-            this.stdout('\x1b[1;37msil\x1b[0m', msg);
+            this.stdout('\x1b[1;37msil\x1b[0m', msg, metadata);
         }
     }
-    debug(msg) {
+    debug(msg, metadata) {
         if (['silly', 'debug'].includes(this.options.level)) {
-            this.stdout('\x1b[1;35mdeb\x1b[0m', msg);
+            this.stdout('\x1b[1;35mdeb\x1b[0m', msg, metadata);
         }
     }
-    verbose(msg) {
+    verbose(msg, metadata) {
         if (['silly', 'debug', 'verbose'].includes(this.options.level)) {
-            this.stdout('\x1b[1;34mver\x1b[0m', msg);
+            this.stdout('\x1b[1;34mver\x1b[0m', msg, metadata);
         }
     }
-    info(msg) {
+    info(msg, metadata) {
         if (['silly', 'debug', 'verbose', 'info'].includes(this.options.level)) {
-            this.stdout('\x1b[1;32minf\x1b[0m', msg);
+            this.stdout('\x1b[1;32minf\x1b[0m', msg, metadata);
         }
     }
-    warn(msg) {
+    warn(msg, metadata) {
         if (['silly', 'debug', 'verbose', 'info', 'warn'].includes(this.options.level)) {
-            this.stderr('\x1b[1;33mwar\x1b[0m', msg);
+            this.stderr('\x1b[1;33mwar\x1b[0m', msg, metadata);
         }
     }
-    error(msg) {
+    error(msg, metadata) {
         if (['silly', 'debug', 'verbose', 'info', 'warn', 'error'].includes(this.options.level)) {
-            this.stderr('\x1b[1;31merr\x1b[0m', msg);
+            this.stderr('\x1b[1;31merr\x1b[0m', msg, metadata);
         }
     }
     getDefaultLogLevel() {

package/dist/models.d.ts

@@ -21,6 +21,10 @@ type LogOptions = {
 	level: LogLevel | undefined;
 };
 
+type Metadata = {
+	[key: string]: string | number | boolean
+}
+
 type UniqueKeyValues = {
 	[key: string]: string;
 };
@@ -29,4 +33,4 @@ type UtilsOptions = {
 	log?: LogInstance;
 };
 
-export { InternalLogOptions, KeyValues, LogInstance, LogLevel, LogOptions, UniqueKeyValues, UtilsOptions };
+export { InternalLogOptions, KeyValues, LogInstance, LogLevel, LogOptions, Metadata, UniqueKeyValues, UtilsOptions };

package/package.json

@@ -1,20 +1,20 @@
 {
   "name": "larvitutils",
-  "version": "5.0.14",
+  "version": "5.1.0",
   "description": "Misc utils",
   "main": "./dist/index.js",
   "files": [
     "/dist"
   ],
   "devDependencies": {
-    "@types/node": "16.11.43",
+    "@types/node": "18.0.6",
     "@types/tape": "4.13.2",
-    "@typescript-eslint/eslint-plugin": "5.30.4",
-    "@typescript-eslint/parser": "5.30.4",
-    "eslint": "8.19.0",
+    "@typescript-eslint/eslint-plugin": "5.30.7",
+    "@typescript-eslint/parser": "5.30.7",
+    "eslint": "8.20.0",
     "nyc": "15.1.0",
     "tape": "5.5.3",
-    "ts-node": "10.8.2",
+    "ts-node": "10.9.1",
     "typescript": "4.7.4"
   },
   "scripts": {