Skip to main content

Interface: WordSegmentationSettings

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

Extended by​

Properties​

softWordBreakDefinitions?​

optional softWordBreakDefinitions?: SoftWordBreakDefinitions

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

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

softWordBreaks?​

optional softWordBreaks?: SoftWordBreaks

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

Allows enabling or disabling soft word break rules by name.

Since​

10.3.1

useIntlWordSegmentation?​

optional useIntlWordSegmentation?: boolean

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

Enables locale-sensitive text segmentation to support languages like Japanese, Chinese, Thai, Lao, Khmer, Myanmar, etc. The locale used for the segmentation is based on the language setting.

Since​

10.2.0