# @types/js-worker-search

> TypeScript definitions for js-worker-search

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

## Install

```sh
npm install @types/js-worker-search
pnpm add @types/js-worker-search
yarn add @types/js-worker-search
bun add @types/js-worker-search
```

## 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.4.5 |
| Published | 2023-11-07 |
| First published | 2020-04-06 |
| 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 | 51432 |
| Maintainers | types |

## Links

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

## Recent versions

- 1.4.5 (latest) — 2023-11-07
- 1.4.2 (ts3.6) — 2021-07-08
- 1.4.1 (ts3.4) — 2021-01-31
- 1.4.0 (ts2.8) — 2020-04-06
- 1.4.4 — 2023-10-18
- 1.4.3 — 2023-09-15

## README

# Installation
> `npm install --save @types/js-worker-search`

# Summary
This package contains type definitions for js-worker-search (https://github.com/bvaughn/js-worker-search).

# Details
Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/js-worker-search.
## [index.d.ts](https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/js-worker-search/index.d.ts)
````ts
export enum INDEX_MODES {
    ALL_SUBSTRINGS = "ALL_SUBSTRINGS",
    EXACT_WORDS = "EXACT_WORDS",
    PREFIXES = "PREFIXES",
}

export default class SearchApi {
    constructor(someParam?: {
        indexMode?: INDEX_MODES | undefined;
        tokenizePattern?: RegExp | undefined;
        caseSensitive?: boolean | undefined;
        matchAnyToken?: boolean | undefined;
    });
    indexDocument(uid: string, text: string): void;
    search(query: string): Promise<string[]>;
    terminate(): void;
}

````

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

# Credits
These definitions were written by [Peter Balogh](https://github.com/pbalogh).

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