Interface: SoftWordBreakDefinitions

Defined in: cspell-types/dist/index.d.mts:1440

Defines a set of word break rules that can be used for text segmentation.

Soft word breaks are done through injecting soft-hyphens at the appropriate positions in the text before spell checking.

This allows for word breaks that might not be captured by the camel case detection.

Note: soft-hyphens are removed before checking the word against the dictionaries.

For example, if there is a soft-hyphen (represented by a |) injected between error and code error|code, the following words would be checked against the dictionaries: errorcode, error, and code.

Since

10.3.1

Indexable

[name: string]: SoftWordBreakRule

A named set of soft word break rules.