@libp2p/interface - npm Package Compare versions

Comparing version 0.1.5 to 0.1.6-c960eb659

dist/src/index.d.ts

@@ -96,2 +96,17 @@ /**
 /**
+ * Logger component for libp2p
+ */
+export interface Logger {
+    (formatter: any, ...args: any[]): void;
+    error(formatter: any, ...args: any[]): void;
+    trace(formatter: any, ...args: any[]): void;
+    enabled: boolean;
+}
+/**
+ * Peer logger component for libp2p
+ */
+export interface ComponentLogger {
+    forComponent(name: string): Logger;
+}
+/**
  * Once you have a libp2p instance, you can listen to several events it emits,
@@ -373,2 +388,3 @@ * so that you can be notified of relevant network events.
     metrics?: Metrics;
+    logger: ComponentLogger;
     /**
@@ -578,2 +594,8 @@ * Get a deduplicated list of peer advertising multiaddrs by concatenating
 /**
+ * An object that contains a Logger as the `log` property.
+ */
+export interface LoggerOptions {
+    log: Logger;
+}
+/**
  * Returns a new type with all fields marked optional.
@@ -580,0 +602,0 @@ *

package.json

 {
   "name": "@libp2p/interface",
-  "version": "0.1.5",
+  "version": "0.1.6-c960eb659",
   "description": "The interface implemented by a libp2p node",
@@ -174,3 +174,3 @@ "license": "Apache-2.0 OR MIT",
   "devDependencies": {
-    "@types/sinon": "^10.0.15",
+    "@types/sinon": "^17.0.0",
     "aegir": "^41.0.2",
@@ -177,0 +177,0 @@ "delay": "^6.0.0",

src/index.ts

@@ -110,2 +110,19 @@ /**
 /**
+ * Logger component for libp2p
+ */
+export interface Logger {
+  (formatter: any, ...args: any[]): void
+  error(formatter: any, ...args: any[]): void
+  trace(formatter: any, ...args: any[]): void
+  enabled: boolean
+}
+
+/**
+ * Peer logger component for libp2p
+ */
+export interface ComponentLogger {
+  forComponent(name: string): Logger
+}
+
+/**
  * Once you have a libp2p instance, you can listen to several events it emits,
@@ -412,2 +429,4 @@ * so that you can be notified of relevant network events.
 
+  logger: ComponentLogger
+
   /**
@@ -632,2 +651,9 @@ * Get a deduplicated list of peer advertising multiaddrs by concatenating
 /**
+ * An object that contains a Logger as the `log` property.
+ */
+export interface LoggerOptions {
+  log: Logger
+}
+
+/**
  * Returns a new type with all fields marked optional.
@@ -634,0 +660,0 @@ *

No alert changes

Worsened metrics

Total package byte prevSize

260449

-10.13%

Number of package files

134

-0.74%

Lines of code

6256

-3.35%

No dependency changes