# @types/line-navigator

> TypeScript definitions for line-navigator

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

## Install

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

## Health

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

Positive: has types; no vulnerabilities; popular repo; extremely popular.

Warnings: low downloads; no esm support.

Negative: abandoned.

## Facts

| | |
|---|---|
| Version | 2.1.4 |
| Published | 2023-11-07 |
| First published | 2020-10-20 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 6.2 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 51374 |
| Maintainers | types |

## Links

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

## Recent versions

- 2.1.4 (latest) — 2023-11-07
- 2.1.2 (ts4.3) — 2023-08-30
- 2.1.1 (ts3.6) — 2021-07-08
- 2.1.0 (ts3.2) — 2020-10-20
- 2.1.3 — 2023-10-18

## README

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

# Summary
This package contains type definitions for line-navigator (https://github.com/anpur/client-line-navigator).

# Details
Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/line-navigator.
## [index.d.ts](https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/line-navigator/index.d.ts)
````ts
declare namespace LineNavigator {
    interface Options {
        /**
         * Encoding
         * @default 'utf8'
         */
        encoding?: string | undefined;
        /**
         * Size of chunk
         * @default 4096
         */
        chunkSize?: number | undefined;
        /**
         * Return error when line is longer than chunkSize, otherwise it will be threated as several lines.
         * @default false
         */
        throwOnLongLines?: boolean | undefined;
    }

    interface FindMatch {
        line: string;
        offset: number;
        length: number;
    }

    interface FindAllResult extends FindMatch {
        index: string;
    }

    type ReadLinesCallback = (
        err: any,
        index: number,
        lines: string[] | undefined,
        isEof: boolean | undefined,
        progress: number | undefined,
    ) => void;
    type FindCallback = (err: any, index: number | undefined, match: FindMatch | undefined) => void;
    type FindAllCallback = (
        err: any,
        index: number,
        limitHit: boolean | undefined,
        results: FindAllResult[] | undefined,
    ) => void;
}

declare class LineNavigator {
    /**
     * Creates an instance of LineNavigator.
     * @param file HTML5 File for client side or a string with file path for server side.
     * @param [options]
     */
    constructor(file: File | string, options?: LineNavigator.Options);

    readSomeLines(indexToStartWith: number, callback: LineNavigator.ReadLinesCallback): void;
    readLines(indexToStartWith: number, numberOfLines: number, callback: LineNavigator.ReadLinesCallback): void;

    find(regex: RegExp, indexToStartWith: number, callback: LineNavigator.FindCallback): void;
    findAll(regex: RegExp, indexToStartWith: number, limit: number, callback: LineNavigator.FindAllCallback): void;
}

export as namespace LineNavigator;
export = LineNavigator;

````

### Additional Details
 * Last updated: Tue, 07 Nov 2023 09:09:38 GMT
 * Dependencies: none

# Credits
These definitions were written by [Vladimir Poluch](https://github.com/vlapo).

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