Constructor options

• confusables
• data
• exclusions
• maxCacheSize
• placeholder
• placeholderMode
• spaceChars
• specialChars

• Optional confusables: string[]

List of dictionary ids to apply transformations from confusables npm package

Default Value

['en', 'es', 'de', 'ru_lat']

index.ts:93

---

• Optional data: Data

Dictionary data

index.ts:60

---

• Optional exclusions: string[]

The list of exclusions

index.ts:105

---

• Optional maxCacheSize: number

Max items to store in the internal cache

Default Value

100

index.ts:100

---

• Optional placeholder: string

Filter placeholder

Default Value

'***'

index.ts:67

---

• Optional placeholderMode: PlaceholderMode

Placeholder mode to either replace with or repeat the placeholder

Default Value

'replace'

index.ts:74

---

• Optional spaceChars: string[]

Pseudo space chars, a list of values for _ symbol replacement in a dictionary word string

Default Value

['', '.', '-', ';', '|']

index.ts:87

---

• Optional specialChars: RegExp

Special chars to allow on start and/or end of a word

Default Value

/\d|[!@#$%^&*()[\];:'",.?\-_=+~`|]|a|(?:the)|(?:el)|(?:la)/

index.ts:81