Interface: SubstitutionDefinition
Defined in: Substitutions.ts:32
Allows for the definition of a substitution set. A substitution set is a collection of substitution entries that can be applied to a document before spell checking. This is useful for converting html entities, url encodings, or other transformations that may be necessary to get the correct text for spell checking.
Substitutions are applied based upon the longest matching find string. If there are multiple matches of the same find,
the last one in the list is used. This allows for the overriding of substitutions. For example, if you have a substitution
for & to and, and then a substitution for & to &, the & substitution will be used for the string &,
and the & substitution will be used for the string &.
Since
9.7.0
Properties
description?
optionaldescription:string
Defined in: Substitutions.ts:41
An optional description of the substitution definition. This is not used for anything, but can be useful for documentation purposes.
entries
entries:
SubstitutionEntry[]
Defined in: Substitutions.ts:46
The entries for the substitution definition. This is a collection of substitution entries that can be applied to a document before spell checking.
name
name:
string
Defined in: Substitutions.ts:36
The name of the substitution definition. This is used to reference the substitution definition in the substitutions array.