amqp-cacoon - npm Package Compare versions

Comparing version 3.1.0 to 3.2.0

build/helpers/message_batching_manager.d.ts

 import { ChannelWrapper, ConsumeMessage, ConsumeBatchMessages } from '../index';
-import { Logger } from 'log4js';
+import { ILogger } from '../types';
 export interface IMessageBatchingManagerConfig {
     providers: {
-        logger?: Logger;
+        logger?: ILogger;
     };
@@ -7,0 +7,0 @@ maxSizeBytes?: number;

build/index.d.ts

 import { ChannelWrapper, AmqpConnectionManagerOptions } from 'amqp-connection-manager';
 import { ConsumeMessage, Channel, ConfirmChannel, Options, Connection } from 'amqplib';
-import { Logger } from 'log4js';
+import { ILogger } from './types';
 declare type ConnectCallback = (channel: ConfirmChannel) => Promise<any>;
@@ -36,3 +36,3 @@ declare type BrokerConnectCallback = (connection: Connection, url: string) => void;
     providers: {
-        logger?: Logger;
+        logger?: ILogger;
     };
@@ -39,0 +39,0 @@ onChannelConnect?: ConnectCallback;

package.json

 {
   "name": "amqp-cacoon",
-  "version": "3.1.0",
+  "version": "3.2.0",
   "description": "AmqpCacoon is an abstraction around amqplib that provides a simple interface with flow control included out of the box",
@@ -21,4 +21,3 @@ "main": "build/index.js",
     "amqplib": "^0.8.0",
-    "lodash": "^4.17.21",
-    "log4js": "^6.4.4"
+    "lodash": "^4.17.21"
   },
@@ -25,0 +24,0 @@ "license": "MIT",

README.md

@@ -277,2 +277,28 @@ # AmqpCacoon
 
+## Logger
+You can pass a logger (optional) as the examples above. For a logger to work, it should have at least the following methods:
+
+- debug
+- error
+- fatal
+- info
+- trace
+
+Some loggers you may use:
+- [log4js](https://www.npmjs.com/package/log4js)
+- [tslog](https://www.npmjs.com/package/tslog)
+- [bunyan](https://www.npmjs.com/package/bunyan)
+
+The examples in the directory **./examples/src** use **log4js**. 
+And for a typescript project, using **tslog** is quite straightforward:  
+
+```typescript
+const logger = new Logger({
+	displayLoggerName: true,
+	minLevel: 'silly',
+	name: 'amqp-cacoon logger',
+	type: 'pretty'
+});
+```
+
 ## Run the Examples
@@ -279,0 +305,0 @@

No alert changes

Improved metrics

Total package byte prevSize

67517

increased by1.57%

Dependency count

3

decreased by-25%

Number of package files

12

increased by33.33%

Lines of code

977

increased by1.35%

Number of lines in readme file

346

increased by8.13%

Dependency changes

• - Removedlog4js@^6.4.4

• - Removeddate-format@4.0.14(transitive)

• - Removeddebug@4.3.4(transitive)

• - Removedflatted@3.3.1(transitive)

• - Removedfs-extra@8.1.0(transitive)

• - Removedgraceful-fs@4.2.11(transitive)

• - Removedjsonfile@4.0.0(transitive)

• - Removedlog4js@6.9.1(transitive)

• - Removedms@2.1.2(transitive)

• - Removedrfdc@1.3.1(transitive)

• - Removedstreamroller@3.1.5(transitive)

• - Removeduniversalify@0.1.2(transitive)