# @types/tail

> TypeScript definitions for tail

Latest version **2.2.3** (published 2023-11-07) · MIT license · 0 weekly downloads

## Install

```sh
npm install @types/tail
pnpm add @types/tail
yarn add @types/tail
bun add @types/tail
```

## Health

**Score 45/100 (D)** — status: abandoned.

Positive: has types; no vulnerabilities; high maintenance score; popular repo; extremely popular.

Warnings: low downloads; no esm support.

Negative: abandoned.

## Facts

| | |
|---|---|
| Version | 2.2.3 |
| Published | 2023-11-07 |
| First published | 2018-05-19 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 4.4 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 51446 |
| Maintainers | types |

## Links

- npm: https://www.npmjs.com/package/@types/tail
- Repository: https://github.com/DefinitelyTyped/DefinitelyTyped
- Homepage: https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/tail
- npm.io page: https://npm.io/package/@types/tail

## Recent versions

- 2.2.3 (latest) — 2023-11-07
- 2.2.1 (ts3.6) — 2021-07-02
- 2.2.0 (ts3.5) — 2021-05-20
- 2.0.0 (ts2.8) — 2019-11-12
- 1.2.2 (ts2.1) — 2019-08-26
- 2.2.2 — 2023-10-18
- 1.2.1 — 2019-02-14
- 1.2.0 — 2018-05-19

## README

# 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](https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/tail/index.d.ts)
````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](https://github.com/spacejack), and [Devin Davies](https://github.com/devindavies).

---
_Source: https://npm.io/package/@types/tail · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._