Installation
npm install --save @types/tail
Summary
This package contains type definitions for tail (https://github.com/lucagrulla/node-tail).
Details
Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/tail.
index.d.ts
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: Tue, 07 Nov 2023 15:11:36 GMT
- Dependencies: none
Credits
These definitions were written by Mike Linkovich, and Devin Davies.