Interface FilterOptions

Constructor options for Filter class.

interface FilterOptions {
    emptyList?: boolean;
    exclude?: string[];
    list?: string[];
    placeHolder?: string;
    regex?: RegExp;
    replaceRegex?: RegExp;
    splitRegex?: RegExp;
}

Properties

emptyList? exclude? list? placeHolder? regex? replaceRegex? splitRegex?

Properties

OptionalemptyList

emptyList?: boolean

Instantiate filter with no blocklist

Optionalexclude

exclude?: string[]

Optionallist

list?: string[]

Instantiate filter with custom list

OptionalplaceHolder

placeHolder?: string

Character used to replace profane words.

Optionalregex

regex?: RegExp

Regular expression used to sanitize words before comparing them to blocklist.

OptionalreplaceRegex

replaceRegex?: RegExp

Regular expression used to replace profane words with placeHolder.

OptionalsplitRegex

splitRegex?: RegExp

Regular expression used to split a string into words.

Settings

Member Visibility

On This Page

Properties