@types/didyoumean/README.md

TypeScript definitions for didyoumean

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

# Summary
This package contains type definitions for didyoumean (https://github.com/dcporter/didyoumean.js).

# Details
Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/didyoumean.
## [index.d.ts](https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/didyoumean/index.d.ts)
````ts
export = didYouMean;

declare function didYouMean(str: string, list: string[] | Array<Record<string, string>>, key?: string): string | null;

declare namespace didYouMean {
    let caseSensitive: boolean;
    let nullResultValue: any;
    let returnFirstMatch: boolean;
    let returnWinningObject: boolean | null;
    let threshold: number | null;
    let thresholdAbsolute: number | null;
}

````

### Additional Details
 * Last updated: Mon, 11 Nov 2024 12:43:54 GMT
 * Dependencies: none

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