mirror of
https://github.com/gosticks/DefinitelyTyped.git
synced 2025-10-16 12:05:41 +00:00
f0ce987bc1
Note that this *trivially* updates project urls by adding the NPM url to the end, even when the urls are almost identical or the DT one is outdated. I'll clean up the urls in a later commit. This PR is unfinished! Please do not merge it yet.
41 lines
1.2 KiB
TypeScript
41 lines
1.2 KiB
TypeScript
// Type definitions for tail 1.2
|
|
// Project: https://github.com/lucagrulla/node-tail, https://www.lucagrulla.com/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;
|