# @types/highlight-words-core

> TypeScript definitions for highlight-words-core

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

## Install

```sh
npm install @types/highlight-words-core
pnpm add @types/highlight-words-core
yarn add @types/highlight-words-core
bun add @types/highlight-words-core
```

## 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 | 1.2.3 |
| Published | 2023-11-07 |
| First published | 2019-11-27 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 3.5 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 51431 |
| Maintainers | types |

## Links

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

## Recent versions

- 1.2.3 (latest) — 2023-11-07
- 1.2.1 (ts3.6) — 2021-07-08
- 1.2.0 (ts2.8) — 2019-11-27
- 1.2.2 — 2023-10-18

## README

# Installation
> `npm install --save @types/highlight-words-core`

# Summary
This package contains type definitions for highlight-words-core (https://github.com/bvaughn/highlight-words-core).

# Details
Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/highlight-words-core.
## [index.d.ts](https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/highlight-words-core/index.d.ts)
````ts
export interface FindChunksArgs {
    autoEscape?: boolean | undefined;
    caseSensitive?: boolean | undefined;
    sanitize?: ((text: string) => string) | undefined;
    searchWords: string[];
    textToHighlight: string;
}

export interface Chunk {
    start: number;
    end: number;
    highlight: boolean;
}

export interface FindAllArgs extends FindChunksArgs {
    findChunks?: ((args: FindChunksArgs) => Chunk[]) | undefined;
}

export function findAll(args: FindAllArgs): Chunk[];

````

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

# Credits
These definitions were written by [James Lismore](https://github.com/jlismore).

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