@timberio/types - npm Package Compare versions

Comparing version 0.13.0 to 0.14.1

dist/cjs/types.d.ts

 /**
+ * Timber library options
+ */
+export interface ITimberOptions {
+    /**
+     * Maximum number of logs to sync in a single request to Timber.io
+     */
+    batchSize: number;
+    /**
+     * Max interval (in milliseconds) before a batch of logs proceeds to syncing
+     */
+    batchInterval: number;
+    /**
+     * Maximum number of sync requests to make concurrently (useful to limit
+     * network I/O)
+     */
+    syncMax: number;
+}
+/**
  * Interface representing a Timber log
@@ -9,4 +27,8 @@ */
 /**
- * Pipeline function type, which takes a log, and returns Promise<ITimberLog>
+ * Middleware type, which takes a log, and returns Promise<ITimberLog>
  */
-export declare type Pipeline = (log: ITimberLog) => Promise<ITimberLog>;
+export declare type Middleware = (log: ITimberLog) => Promise<ITimberLog>;
+/**
+ * Sync type, which takes a array of logs, and resolves the logs
+ */
+export declare type Sync = (logs: ITimberLog[]) => Promise<ITimberLog[]>;

dist/cjs/types.js

 "use strict";
+/**
+ * Timber library options
+ */
 Object.defineProperty(exports, "__esModule", { value: true });
 //# sourceMappingURL=types.js.map

dist/es6/types.d.ts

 /**
+ * Timber library options
+ */
+export interface ITimberOptions {
+    /**
+     * Maximum number of logs to sync in a single request to Timber.io
+     */
+    batchSize: number;
+    /**
+     * Max interval (in milliseconds) before a batch of logs proceeds to syncing
+     */
+    batchInterval: number;
+    /**
+     * Maximum number of sync requests to make concurrently (useful to limit
+     * network I/O)
+     */
+    syncMax: number;
+}
+/**
  * Interface representing a Timber log
@@ -9,4 +27,8 @@ */
 /**
- * Pipeline function type, which takes a log, and returns Promise<ITimberLog>
+ * Middleware type, which takes a log, and returns Promise<ITimberLog>
  */
-export declare type Pipeline = (log: ITimberLog) => Promise<ITimberLog>;
+export declare type Middleware = (log: ITimberLog) => Promise<ITimberLog>;
+/**
+ * Sync type, which takes a array of logs, and resolves the logs
+ */
+export declare type Sync = (logs: ITimberLog[]) => Promise<ITimberLog[]>;

dist/es6/types.js

@@ -0,1 +1,4 @@
+/**
+ * Timber library options
+ */
 //# sourceMappingURL=types.js.map

package.json

 {
   "name": "@timberio/types",
-  "version": "0.13.0",
+  "version": "0.14.1",
   "description": "Timber.io - Typescript types",
@@ -40,3 +40,3 @@ "keywords": [
   },
-  "gitHead": "9643811061b3c12daf7b094931bee1994c850b0b",
+  "gitHead": "a358ed0c3567f31d00dc96258b73bc9062d59c17",
   "dependencies": {
@@ -43,0 +43,0 @@ "js": "^0.1.0"

src/types.ts

 /**
+ * Timber library options
+ */
+
+export interface ITimberOptions {
+  /**
+   * Maximum number of logs to sync in a single request to Timber.io
+   */
+  batchSize: number;
+
+  /**
+   * Max interval (in milliseconds) before a batch of logs proceeds to syncing
+   */
+  batchInterval: number;
+
+  /**
+   * Maximum number of sync requests to make concurrently (useful to limit
+   * network I/O)
+   */
+  syncMax: number;
+}
+
+/**
  * Interface representing a Timber log
@@ -10,4 +32,9 @@ */
 /**
- * Pipeline function type, which takes a log, and returns Promise<ITimberLog>
+ * Middleware type, which takes a log, and returns Promise<ITimberLog>
  */
-export type Pipeline = (log: ITimberLog) => Promise<ITimberLog>;
+export type Middleware = (log: ITimberLog) => Promise<ITimberLog>;
+
+/**
+ * Sync type, which takes a array of logs, and resolves the logs
+ */
+export type Sync = (logs: ITimberLog[]) => Promise<ITimberLog[]>;

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

Improved metrics

Total package byte prevSize

5012

increased by56.04%

Lines of code

107

increased by205.71%

No dependency changes