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

# Summary
This package contains type definitions for bad-words (https://github.com/web-mech/badwords#readme).

# Details
Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/bad-words.
## [index.d.ts](https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/bad-words/index.d.ts)
````ts
interface Options {
    emptyList?: boolean | undefined;
    exclude?: string[] | undefined;
    list?: string[] | undefined;
    placeHolder?: string | undefined;
    regex?: RegExp | undefined;
    replaceRegex?: RegExp | undefined;
    splitRegex?: RegExp | undefined;
}

declare class BadWordsFilter {
    constructor(options?: Options);

    addWords(...words: string[]): void;
    clean(text: string): string;
    isProfane(text: string): boolean;
    removeWords(...words: string[]): void;
    replaceWord(text: string): string;
}

export = BadWordsFilter;

````

### Additional Details
 * Last updated: Mon, 06 Nov 2023 22:41:04 GMT
 * Dependencies: none

# Credits
These definitions were written by [Tom Pridham](https://github.com/TomPridham).