@types/tail
    TypeScript icon, indicating that this package has built-in type declarations

    2.2.1 • Public • Published

    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

    // 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: Fri, 02 Jul 2021 21:32:10 GMT
    • Dependencies: none
    • Global values: none

    Credits

    These definitions were written by Mike Linkovich, and Devin Davies.

    Keywords

    none

    Install

    npm i @types/tail

    DownloadsWeekly Downloads

    5,254

    Version

    2.2.1

    License

    MIT

    Unpacked Size

    5.13 kB

    Total Files

    4

    Last publish

    Collaborators

    • types