mirror of
https://github.com/gosticks/DefinitelyTyped.git
synced 2026-08-16 23:10:29 +00:00
Add types for tail module
This commit is contained in:
Vendored
+40
@@ -0,0 +1,40 @@
|
||||
// Type definitions for tail 1.2
|
||||
// Project: https://github.com/lucagrulla/node-tail
|
||||
// Definitions by: Mike Linkovich <https://github.com/spacejack>
|
||||
// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
|
||||
// TypeScript Version: 2.1
|
||||
|
||||
declare namespace Tail {
|
||||
interface TailOptions {
|
||||
separator?: string | RegExp;
|
||||
fromBeginning?: boolean;
|
||||
fsWatchOptions?: Record<string, any>;
|
||||
follow?: boolean;
|
||||
logger?: any;
|
||||
encoding?: string;
|
||||
useWatchFile?: boolean;
|
||||
}
|
||||
|
||||
interface Tail {
|
||||
/** 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;
|
||||
}
|
||||
|
||||
interface TailConstructor {
|
||||
/** Creates a new Tail object that starts watching the specified file immediately. */
|
||||
new(filename: string, options?: TailOptions): Tail;
|
||||
}
|
||||
|
||||
interface Static {
|
||||
Tail: TailConstructor;
|
||||
}
|
||||
}
|
||||
|
||||
declare const Tail: Tail.Static;
|
||||
export = Tail;
|
||||
@@ -0,0 +1,26 @@
|
||||
import { Tail } from 'tail';
|
||||
|
||||
const tail = new Tail("test.txt");
|
||||
|
||||
tail.on("line", data => {
|
||||
console.log(data);
|
||||
});
|
||||
|
||||
tail.on("error", error => {
|
||||
console.log('ERROR: ', error);
|
||||
});
|
||||
|
||||
tail.unwatch();
|
||||
|
||||
tail.watch();
|
||||
|
||||
// With options object
|
||||
const tail2 = new Tail("test2.txt", {
|
||||
separator: /[\r]{0,1}\n/,
|
||||
fromBeginning: false,
|
||||
fsWatchOptions: {},
|
||||
follow: true,
|
||||
logger: console,
|
||||
useWatchFile: false,
|
||||
encoding: 'utf-8'
|
||||
});
|
||||
@@ -0,0 +1,19 @@
|
||||
{
|
||||
"compilerOptions": {
|
||||
"module": "commonjs",
|
||||
"lib": ["es2015", "dom"],
|
||||
"noImplicitAny": true,
|
||||
"noImplicitThis": true,
|
||||
"strictFunctionTypes": true,
|
||||
"strictNullChecks": true,
|
||||
"forceConsistentCasingInFileNames": true,
|
||||
"noEmit": true,
|
||||
"baseUrl": "../",
|
||||
"typeRoots": ["../"],
|
||||
"types": []
|
||||
},
|
||||
"files": [
|
||||
"index.d.ts",
|
||||
"test.ts"
|
||||
]
|
||||
}
|
||||
@@ -0,0 +1,3 @@
|
||||
{
|
||||
"extends": "dtslint/dt.json"
|
||||
}
|
||||
Reference in New Issue
Block a user