@emartech/json-logger - npm Package Compare versions

Comparing version 5.0.2 to 6.0.0

dist/index.d.ts

 import { Logger, LoggerConfig } from './logger/logger';
 export { Logger, LoggerConfig } from './logger/logger';
 export { Timer } from './timer/timer';
-export declare function logFactory(namespace: string): Logger;
-export declare namespace logFactory {
-    var Logger: typeof import("./logger/logger").Logger;
-    var Timer: typeof import("./timer/timer").Timer;
+export declare function createLogger(namespace: string): Logger;
+export declare namespace createLogger {
     var getNamespaces: () => string;
@@ -16,2 +14,1 @@ var configure: (options: LoggerConfig) => void;
 }
-export default logFactory;

dist/index.js

 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.logFactory = exports.Timer = exports.Logger = void 0;
+exports.createLogger = exports.Timer = exports.Logger = void 0;
 const logger_1 = require("./logger/logger");
 var logger_2 = require("./logger/logger");
 Object.defineProperty(exports, "Logger", { enumerable: true, get: function () { return logger_2.Logger; } });
-const timer_1 = require("./timer/timer");
-var timer_2 = require("./timer/timer");
-Object.defineProperty(exports, "Timer", { enumerable: true, get: function () { return timer_2.Timer; } });
+var timer_1 = require("./timer/timer");
+Object.defineProperty(exports, "Timer", { enumerable: true, get: function () { return timer_1.Timer; } });
 const enabled_1 = require("./enabled/enabled");
 const formatter_1 = require("./formatter");
-function logFactory(namespace) {
-    return new logger_1.Logger(namespace, (0, enabled_1.isNamespaceEnabled)(logFactory.getNamespaces(), namespace));
+function createLogger(namespace) {
+    return new logger_1.Logger(namespace, (0, enabled_1.isNamespaceEnabled)(createLogger.getNamespaces(), namespace));
 }
-exports.logFactory = logFactory;
-logFactory.Logger = logger_1.Logger;
-logFactory.Timer = timer_1.Timer;
-logFactory.getNamespaces = function () {
+exports.createLogger = createLogger;
+createLogger.getNamespaces = function () {
     return process.env.DEBUG || '';
 };
-logFactory.configure = function (options) {
+createLogger.configure = function (options) {
     logger_1.Logger.configure(options);
 };
-logFactory.formatter = formatter_1.formatter;
-exports.default = logFactory;
-module.exports = logFactory;
+createLogger.formatter = formatter_1.formatter;

package.json

 {
   "name": "@emartech/json-logger",
-  "version": "5.0.2",
+  "version": "6.0.0",
   "description": "Tiny and fast json logger with namespace support",
@@ -5,0 +5,0 @@ "main": "dist/index.js",

README.md

@@ -14,6 +14,9 @@ # @emartech/json-logger
 
+#### Script
+
 ```javascript
 process.env.DEBUG = 'redis';
-const mongoLogger = require('@emartech/json-logger')('mongo');
-const redisLogger = require('@emartech/json-logger')('redis');
+const { createLogger } = require('@emartech/json-logger');
+const mongoLogger = createLogger('mongo');
+const redisLogger = createLogger('redis');
 
@@ -30,2 +33,43 @@ redisLogger.info('connected', { domain: 'yahoo' });
 
+#### Class
+
+```javascript
+const { createLogger } = require('@emartech/json-logger');
+const logger = createLogger('Exporter');
+
+class Exporter {
+  export() {
+    mongoLogger.info('export', { customer_id: 123 });
+  }
+}
+```
+
+```typescript
+import { createLogger } from '@emartech/json-logger';
+const logger = createLogger('Exporter');
+
+class Exporter {
+  export() {
+    mongoLogger.info('export', { customer_id: 123 });
+  }
+}
+```
+
+#### Tests
+
+```javascript
+import { Logger } from '@emartech/json-logger';
+
+describe('Exporter', () => {
+  it('should log', () => {
+    jest.spyOn(Logger.prototype, 'info').mockReturnValue();
+    const exporter = new Exporter();
+    
+    exporter.export();
+
+    expect(Logger.prototype.info).toHaveBeenCalledWith('export', { customer_id: 123 });
+  })
+});
+```
+
 More examples can be found in the `examples` directory.
@@ -44,7 +88,8 @@
 process.env.DEBUG = 'redis,mysql';
+const { createLogger } = require('@emartech/json-logger');
 
-const mongoLogger = require('@emartech/json-logger')('mongo');
+const mongoLogger = createLogger('mongo');
 // mongo instance will be disabled
 
-const redisLogger = require('@emartech/json-logger')('redis');
+const redisLogger = createLogger('redis');
 // redis instance will be enabled
@@ -58,3 +103,4 @@ ```
 ```javascript
-const redisLogger = require('@emartech/json-logger')('redis');
+const { createLogger } = require('@emartech/json-logger');
+const redisLogger = createLogger('redis');
 
@@ -99,3 +145,4 @@ redisLogger.info('connected', { domain: 'yahoo' });
 ```javascript
-const redisLogger = require('@emartech/json-logger')('redis');
+const { createLogger } = require('@emartech/json-logger');
+const redisLogger = createLogger('redis');
 
@@ -117,3 +164,4 @@ redisLogger.fromError('query', new Error('Unauthorized'), { problem: 'missmatch' });
 ```javascript
-const redisLogger = require('@emartech/json-logger')('redis');
+const { createLogger } = require('@emartech/json-logger');
+const redisLogger = createLogger('redis');
 
@@ -136,5 +184,5 @@ const timer = redisLogger.timer();
 ```javascript
-const Logger = require('@emartech/json-logger');
+const { createLogger } = require('@emartech/json-logger');
 
-Logger.configure({
+createLogger.configure({
   formatter: JSON.stringify,
@@ -170,7 +218,7 @@ output: console.log,
 const Koa = require('koa');
-const logFactory = require('@emartech/json-logger');
+const { createLogger } = require('@emartech/json-logger');
 const clsAdapter = require('@emartech/cls-adapter');
-const logger = logFactory('redis');
+const logger = createLogger('redis');
 
-logFactory.configure({
+createLogger.configure({
   transformers: [
@@ -177,0 +225,0 @@ clsAdapter.addContextStorageToInput()

No alert changes

Improved metrics

Total package byte prevSize

39429

increased by1.78%

Number of lines in readme file

232

increased by26.09%

Worsened metrics

Lines of code

624

decreased by-1.27%

No dependency changes