@nkzw/profane/lib/profane.d.ts

Zero dependency profanity detector.

type WordList = Record<string, ReadonlyArray<string>>;
export declare function getWordList(): WordList;
export default class Profane {
    private readonly options;
    private words;
    constructor(options?: {
        words?: WordList;
        normalize?: boolean;
        wholeWordsOnly?: boolean;
    });
    private scan;
    check(text: string): boolean;
    censor(censored: string, replacement?: string): string;
    getWordFrequencies(text: string): Record<string, number>;
    getCategoryFrequencies(text: string): Record<string, number>;
}
export {};