# @types/spellchecker

> TypeScript definitions for spellchecker

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

## Install

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

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

## Links

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

## Recent versions

- 3.5.2 (latest) — 2023-11-07
- 3.5.0 (ts2.1) — 2019-02-07
- 3.5.1 — 2023-10-18

## README

# Installation
> `npm install --save @types/spellchecker`

# Summary
This package contains type definitions for spellchecker (http://atom.github.io/node-spellchecker).

# Details
Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/spellchecker.
## [index.d.ts](https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/spellchecker/index.d.ts)
````ts
/* ---------------------------------------------------------------------------
                       Custom Types / Interfaces
--------------------------------------------------------------------------- */
/**
 * MisspelledLocation - shape of an object returned by checkSpelling to
 * identify locations of misspelled words in a corpus.
 * @description a misspelled word can be found by corpus.slice(start, end)
 * start - start index of a misspelled word in a corpus
 * end - end index of a misspelled word in a corpus
 */
export interface MisspelledLocation {
    start: number;
    end: number;
}

/* ---------------------------------------------------------------------------
                                Methods
--------------------------------------------------------------------------- */
/**
 * Spellchecker.isMisspelled - Check if a word is misspelled.
 * @param word - String word to check.
 * @returns boolean - true if the word is misspelled, false otherwise.
 */
export function isMisspelled(word: string): boolean;

/**
 * Spellchecker.getCorrectionsForMisspelling - Get the corrections for a misspelled word.
 * @param word - String word to get corrections for.
 * @returns array - Returns a non-null but possibly empty array of string corrections.
 */
export function getCorrectionsForMisspelling(word: string): string[];

/**
 * Spellchecker.checkSpelling - Identify misspelled words in a corpus of text.
 * @param corpus - String corpus of text to spellcheck.
 * @returns array - Returns an Array containing {start, end} objects that describe an
 *                  index range within the original String that contains a misspelled word.
 */
export function checkSpelling(corpus: string): MisspelledLocation[];

/**
 * Spellchecker.checkSpellingAsync - Asynchronously identify misspelled words.
 * @param corpus - String corpus of text to spellcheck.
 * @returns array - Returns a Promise that resolves with the Array described by checkSpelling().
 */
export function checkSpellingAsync(corpus: string): Promise<MisspelledLocation[]>;

/**
 * Spellchecker.add - Adds a word to the dictionary.
 * When using Hunspell, this will not modify the .dic file;
 * new words must be added each time the spellchecker is created. Use a custom dictionary file.
 * @param word - String word to add.
 * @returns void
 */
export function add(word: string): void;

````

### Additional Details
 * Last updated: Tue, 07 Nov 2023 15:11:36 GMT
 * Dependencies: none

# Credits
These definitions were written by [Dale Fenton](https://github.com/dalevfenton).

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