gelf-pro - npm Package Compare versions

Comparing version 1.3.1 to 1.3.2

package.json

 {
   "name": "gelf-pro",
-  "version": "1.3.1",
+  "version": "1.3.2",
   "main": "./lib/gelf-pro.js",
@@ -30,3 +30,3 @@ "typings": "./typings/index.d.ts",
     "async": "2.6.2",
-    "lodash": "4.17.11"
+    "lodash": "4.17.14"
   },
@@ -33,0 +33,0 @@ "devDependencies": {

README.md

@@ -169,2 +169,3 @@ node-gelf pro
 - [joelharkes](https://github.com/joelharkes)
+- [mkalam-alami](https://github.com/mkalam-alami)
 
@@ -171,0 +172,0 @@ #### License

typings/index.d.ts

@@ -1,40 +0,65 @@
-import { send } from "../lib/adapter/udp";
+/**
+  You can declare your available logging methods by augmenting this module. Example with the default levels:
+  ```
+  declare module 'gelf-pro' {
+    function emergency(message: Message, extra?: MessageExtra, callback?: MessageCallback);
+    function alert(message: Message, extra?: MessageExtra, callback?: MessageCallback);
+    function critical(message: Message, extra?: MessageExtra, callback?: MessageCallback);
+    function error(message: Message, extra?: MessageExtra, callback?: MessageCallback);
+    function warning(message: Message, extra?: MessageExtra, callback?: MessageCallback);
+    function warn(message: Message, extra?: MessageExtra, callback?: MessageCallback);
+    function notice(message: Message, extra?: MessageExtra, callback?: MessageCallback);
+    function info(message: Message, extra?: MessageExtra, callback?: MessageCallback);
+    function debug(message: Message, extra?: MessageExtra, callback?: MessageCallback);
+    function log(message: Message, extra?: MessageExtra, callback?: MessageCallback);
+  }
+  ```
+ */
 
-declare namespace GelfPro {
+declare module 'gelf-pro' {
 
-  interface Logger {
-    setConfig(opts: GelfPro.Settings): GelfPro.Logger;
-    getAdapter(): Adapter
+  export type Message = string | Error;
+  export type MessageExtra = object | Error;
+  export type MessageCallback = (error?: Error, packetLength?: number) => void;
+
+  export function setConfig(opts: Partial<Settings>): void;
+  export function getAdapter(): Adapter;
+  export function getStringFromObject(object: object): string;
+  export function send(message: Message, callback: MessageCallback);
+  export function message(message: Message, lvl: number, extra?: MessageExtra, callback?: MessageCallback);
+
+  export interface Logger {
+    setConfig(opts: Partial<Settings>): Logger;
+    getAdapter(): Adapter;
     getStringFromObject(object: object): string;
-    send(message: string, callback: (error?: Error, packetLength?: number) => void);
-    message(message: string, lvl: number, extra: any, callback: (error?: Error, packetLength?: number) => void);
+    send(message: Message, callback: MessageCallback);
+    message(message: Message, lvl: number, extra: any, callback: MessageCallback);
   }
 
-  interface Adapter {
+  export interface Adapter {
     setOptions(options: any): Adapter;
-    send(message: string, callback: (error?: Error, packetLength?: number) => void);
+    send(message: Message, callback: MessageCallback);
   }
 
-
-  interface Settings {
+  export interface Settings {
     /**
      * Default fields for all messages.
      */
-    fields?: { [key: string]: any },
+    fields: { [key: string]: any },
     /**
      * Filter functions, return false in any of them to not send the log message.
      */
-    filter?: Array<(message: any) => boolean>;
+    filter: Array<(message: any) => boolean>;
     /**
      * Transformer methods, to transform log message.
      */
-    transform?: Array<(message: any) => any>;
+    transform: Array<(message: any) => any>;
     /**
      * @default {emergency: 0, alert: 1, critical: 2, error: 3, warning: 4, notice: 5, info: 6, debug: 7}
      */
-    levels?: { [levelName: string]: number },
+    levels: { [levelName: string]: number },
     /**
      * Log level aliases: {alias: logLevelName}
      */
-    aliases?: { [allias: string]: string }
+    aliases: { [allias: string]: string }
     /**
@@ -81,8 +106,5 @@ * @default udp
       ca?: string;
-    },
-    levels: { [key: string]: number }
+    }
   }
 
 }
-
-export default GelfPro.Logger

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Major refactor

Supply chain risk

Package has recently undergone a major refactor. It may be unstable or indicate significant internal changes. Use caution when updating to versions that include significant changes.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

120651

increased by0.38%

Number of lines in readme file

174

increased by0.58%

Number of medium supply chain risk alerts

6

decreased by-14.29%

Worsened metrics

Lines of code

3300

decreased by-0.06%

Dependency changes

• + Addedlodash@4.17.14(transitive)

• - Removedlodash@4.17.11(transitive)

• Updatedlodash@4.17.14