# @types/line-reader

> TypeScript definitions for line-reader

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

## Install

```sh
npm install @types/line-reader
pnpm add @types/line-reader
yarn add @types/line-reader
bun add @types/line-reader
```

## 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; pre 1.0.

Negative: abandoned.

## Facts

| | |
|---|---|
| Version | 0.0.37 |
| Published | 2023-11-07 |
| First published | 2016-05-17 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 1 |
| Unpacked size | 5 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 51439 |
| Maintainers | types |

## Links

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

## Dependencies (1)

- [@types/node](https://npm.io/package/@types/node.md) *

## Recent versions

- 0.0.37 (latest) — 2023-11-07
- 0.0.35 (ts4.3) — 2023-08-30
- 0.0.34 (ts3.6) — 2021-07-08
- 0.0.33 (ts3.4) — 2021-02-04
- 0.0.31 (ts3.3) — 2021-01-05
- 0.0.30 (ts3.0) — 2020-06-25
- 0.0.28 (ts2.0) — 2016-09-19
- 0.0.36 — 2023-10-18
- 0.0.32 — 2021-01-13
- 0.0.29 — 2020-05-15
- 0.0.27 — 2016-07-14
- 0.0.26-alpha — 2016-07-08
- 0.0.25-alpha — 2016-07-04
- 0.0.24-alpha — 2016-07-02
- 0.0.23-alpha — 2016-07-01
- … 5 more at https://npm.io/package/@types/line-reader/versions

## README

# Installation
> `npm install --save @types/line-reader`

# Summary
This package contains type definitions for line-reader (https://github.com/nickewing/line-reader).

# Details
Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/line-reader.
## [index.d.ts](https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/line-reader/index.d.ts)
````ts
/// <reference types="node"/>

interface LineReaderOptions {
    separator?: any;
    encoding?: string | undefined;
    bufferSize?: number | undefined;
}

interface Reader {
    hasNextLine(): boolean;
    nextLine(cb: (err: Error, line?: string) => void): void;
    close(cb: (err: Error) => void): void;
    isOpen(): boolean;
    isClosed(): boolean;
    getReadStream(): NodeJS.ReadableStream;
}

interface LineReader {
    open(): Function;
    open(
        file: string | NodeJS.ReadableStream,
        options: LineReaderOptions,
        cb: (err: Error, reader: Reader) => void,
    ): void;
    open(file: string | NodeJS.ReadableStream, cb: (err: Error, reader: Reader) => void): void;

    eachLine(): Function; // For Promise.promisify;
    eachLine(
        file: string | NodeJS.ReadableStream,
        options: LineReaderOptions,
        cb: (line: string, last: boolean, continueCb?: Function) => void,
        errCb?: (err?: Error) => void,
    ): LineReader;
    eachLine(
        file: string | NodeJS.ReadableStream,
        cb: (line: string, last: boolean, continueCb?: Function) => void,
        errCb?: (err?: Error) => void,
    ): LineReader;
}

declare module "line-reader" {
    var lr: LineReader;
    export = lr;
}

````

### Additional Details
 * Last updated: Tue, 07 Nov 2023 09:09:38 GMT
 * Dependencies: [@types/node](https://npmjs.com/package/@types/node)

# Credits
These definitions were written by [Sam Saint-Pettersen](https://github.com/stpettersens).

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