@types/tail - npm Package Compare versions

Comparing version 2.2.0 to 2.2.1

tail/index.d.ts

@@ -8,11 +8,11 @@ // Type definitions for tail 2.2
 export interface TailOptions {
-    separator?: string | RegExp | null;
-    fromBeginning?: boolean;
-    fsWatchOptions?: Record<string, any>;
-    follow?: boolean;
+    separator?: string | RegExp | null | undefined;
+    fromBeginning?: boolean | undefined;
+    fsWatchOptions?: Record<string, any> | undefined;
+    follow?: boolean | undefined;
     logger?: any;
-    encoding?: string;
-    useWatchFile?: boolean;
-    flushAtEOF?: boolean;
-    nLines?: number;
+    encoding?: string | undefined;
+    useWatchFile?: boolean | undefined;
+    flushAtEOF?: boolean | undefined;
+    nLines?: number | undefined;
 }
@@ -19,0 +19,0 @@

tail/package.json

 {
     "name": "@types/tail",
-    "version": "2.2.0",
+    "version": "2.2.1",
     "description": "TypeScript definitions for tail",
+    "homepage": "https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/tail",
     "license": "MIT",
@@ -27,4 +28,4 @@ "contributors": [
     "dependencies": {},
-    "typesPublisherContentHash": "2b623736f5ae3c12c395faedba7016de873945d2daf1a0449b8adcb01355c486",
-    "typeScriptVersion": "3.5"
+    "typesPublisherContentHash": "598ade768fdd7dfae6c440fd74761634e691e430d22488e954e67330f7bfa73c",
+    "typeScriptVersion": "3.6"
 }

tail/README.md

@@ -9,5 +9,39 @@ # Installation
 Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/tail.
+## [index.d.ts](https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/tail/index.d.ts)
+````ts
+// Type definitions for tail 2.2
+// Project: https://github.com/lucagrulla/node-tail, https://www.lucagrulla.com/node-tail
+// Definitions by: Mike Linkovich <https://github.com/spacejack>
+//                 Devin Davies <https://github.com/devindavies>
+// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
 
+export interface TailOptions {
+    separator?: string | RegExp | null | undefined;
+    fromBeginning?: boolean | undefined;
+    fsWatchOptions?: Record<string, any> | undefined;
+    follow?: boolean | undefined;
+    logger?: any;
+    encoding?: string | undefined;
+    useWatchFile?: boolean | undefined;
+    flushAtEOF?: boolean | undefined;
+    nLines?: number | undefined;
+}
+
+export class Tail {
+    /** Creates a new Tail object that starts watching the specified file immediately. */
+    constructor(filename: string, options?: TailOptions);
+    /** Callback to listen for newlines appended to file */
+    on(eventType: "line", cb: (data: any) => void): void;
+    /** Error callback */
+    on(eventType: "error", cb: (error: any) => void): void;
+    /** Stop watching file */
+    unwatch(): void;
+    /** Start watching file if previously stopped */
+    watch(): void;
+}
+
+````
+
 ### Additional Details
- * Last updated: Thu, 20 May 2021 21:01:46 GMT
+ * Last updated: Fri, 02 Jul 2021 21:32:10 GMT
  * Dependencies: none
@@ -14,0 +48,0 @@ * Global values: none

Fixed alerts

No website

Quality

Package does not have a website.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

5126

41.56%

Number of low quality alerts

0

-100%

Number of lines in readme file

51

200%

No dependency changes