Class LineSegmenter

An ICU4X line-break segmenter, capable of finding breakpoints in strings.

See the Rust documentation for LineSegmenter for more information.

Index

Methods

autoWithOptions autoWithOptionsAndProvider createAuto createDictionary createForNonComplexScripts createLstm dictionaryWithOptions dictionaryWithOptionsAndProvider forNonComplexScriptsWithOptions forNonComplexScriptsWithOptionsAndProvider lstmWithOptions lstmWithOptionsAndProvider segment

Methods

`Static`autoWithOptions

autoWithOptions(
contentLocale: Locale | null,
options: LineBreakOptions_obj,
): LineSegmenter
Construct a LineSegmenter with custom options using compiled data. It automatically loads the best available payload data for Burmese, Khmer, Lao, and Thai.

See the Rust documentation for new_auto for more information.
Parameters
- contentLocale: Locale | null
- options: LineBreakOptions_obj
Returns LineSegmenter
- Defined in LineSegmenter.d.ts:62

`Static`autoWithOptionsAndProvider

autoWithOptionsAndProvider(
    provider: DataProvider,
    contentLocale: Locale | null,
    options: LineBreakOptions_obj,
): LineSegmenter
Construct a LineSegmenter with custom options. It automatically loads the best available payload data for Burmese, Khmer, Lao, and Thai, using a particular data source.

See the Rust documentation for new_auto for more information.
Parameters
- provider: DataProvider
- contentLocale: Locale | null
- options: LineBreakOptions_obj
Returns LineSegmenter
- Defined in LineSegmenter.d.ts:70

`Static`createAuto

createAuto(): LineSegmenter
Construct a LineSegmenter with default options (no locale-based tailoring) using compiled data. It automatically loads the best available payload data for Burmese, Khmer, Lao, and Thai.

See the Rust documentation for new_auto for more information.

Returns LineSegmenter
- Defined in LineSegmenter.d.ts:30

`Static`createDictionary

createDictionary(): LineSegmenter
Construct a LineSegmenter with default options (no locale-based tailoring) and dictionary payload data for Burmese, Khmer, Lao, and Thai, using compiled data

See the Rust documentation for new_dictionary for more information.

Returns LineSegmenter
- Defined in LineSegmenter.d.ts:46

`Static`createForNonComplexScripts

createForNonComplexScripts(): LineSegmenter
Construct a LineSegmenter with default options (no locale-based tailoring) and no support for scripts requiring complex context dependent line breaks (Burmese, Khmer, Lao, and Thai), using compiled data

See the Rust documentation for new_for_non_complex_scripts for more information.

Returns LineSegmenter
- Defined in LineSegmenter.d.ts:54

`Static`createLstm

createLstm(): LineSegmenter
Construct a LineSegmenter with default options (no locale-based tailoring) and LSTM payload data for Burmese, Khmer, Lao, and Thai, using compiled data.

See the Rust documentation for new_lstm for more information.

Returns LineSegmenter
- Defined in LineSegmenter.d.ts:38

`Static`dictionaryWithOptions

dictionaryWithOptions(
contentLocale: Locale | null,
options: LineBreakOptions_obj,
): LineSegmenter
Construct a LineSegmenter with custom options and dictionary payload data for Burmese, Khmer, Lao, and Thai, using compiled data.

See the Rust documentation for new_dictionary for more information.
Parameters
- contentLocale: Locale | null
- options: LineBreakOptions_obj
Returns LineSegmenter
- Defined in LineSegmenter.d.ts:94

`Static`dictionaryWithOptionsAndProvider

dictionaryWithOptionsAndProvider(
    provider: DataProvider,
    contentLocale: Locale | null,
    options: LineBreakOptions_obj,
): LineSegmenter
Construct a LineSegmenter with custom options and dictionary payload data for Burmese, Khmer, Lao, and Thai, using a particular data source.

See the Rust documentation for new_dictionary for more information.
Parameters
- provider: DataProvider
- contentLocale: Locale | null
- options: LineBreakOptions_obj
Returns LineSegmenter
- Defined in LineSegmenter.d.ts:102

`Static`forNonComplexScriptsWithOptions

forNonComplexScriptsWithOptions(
contentLocale: Locale | null,
options: LineBreakOptions_obj,
): LineSegmenter
Construct a LineSegmenter with custom options and no support for scripts requiring complex context dependent line breaks (Burmese, Khmer, Lao, and Thai), using compiled data.

See the Rust documentation for new_for_non_complex_scripts for more information.
Parameters
- contentLocale: Locale | null
- options: LineBreakOptions_obj
Returns LineSegmenter
- Defined in LineSegmenter.d.ts:110

`Static`forNonComplexScriptsWithOptionsAndProvider

forNonComplexScriptsWithOptionsAndProvider(
    provider: DataProvider,
    contentLocale: Locale | null,
    options: LineBreakOptions_obj,
): LineSegmenter
Construct a LineSegmenter with custom options and no support for complex languages (Burmese, Khmer, Lao, and Thai), using a particular data source.

See the Rust documentation for new_for_non_complex_scripts for more information.
Parameters
- provider: DataProvider
- contentLocale: Locale | null
- options: LineBreakOptions_obj
Returns LineSegmenter
- Defined in LineSegmenter.d.ts:118

`Static`lstmWithOptions

lstmWithOptions(
contentLocale: Locale | null,
options: LineBreakOptions_obj,
): LineSegmenter
Construct a LineSegmenter with custom options and LSTM payload data for Burmese, Khmer, Lao, and Thai, using compiled data.

See the Rust documentation for new_lstm for more information.
Parameters
- contentLocale: Locale | null
- options: LineBreakOptions_obj
Returns LineSegmenter
- Defined in LineSegmenter.d.ts:78

`Static`lstmWithOptionsAndProvider

lstmWithOptionsAndProvider(
    provider: DataProvider,
    contentLocale: Locale | null,
    options: LineBreakOptions_obj,
): LineSegmenter
Construct a LineSegmenter with custom options and LSTM payload data for Burmese, Khmer, Lao, and Thai, using a particular data source.

See the Rust documentation for new_lstm for more information.
Parameters
- provider: DataProvider
- contentLocale: Locale | null
- options: LineBreakOptions_obj
Returns LineSegmenter
- Defined in LineSegmenter.d.ts:86

segment

segment(input: string): LineBreakIteratorUtf16
Segments a string.

Ill-formed input is treated as if errors had been replaced with REPLACEMENT CHARACTERs according to the WHATWG Encoding Standard.

See the Rust documentation for segment_utf16 for more information.
Parameters
- input: string
Returns LineBreakIteratorUtf16
- Defined in LineSegmenter.d.ts:128

Class LineSegmenter

Index

Methods

Methods

StaticautoWithOptions

Parameters

Returns LineSegmenter

StaticautoWithOptionsAndProvider

Parameters

Returns LineSegmenter

StaticcreateAuto

Returns LineSegmenter

StaticcreateDictionary

Returns LineSegmenter

StaticcreateForNonComplexScripts

Returns LineSegmenter

StaticcreateLstm

Returns LineSegmenter

StaticdictionaryWithOptions

Parameters

Returns LineSegmenter

StaticdictionaryWithOptionsAndProvider

Parameters

Returns LineSegmenter

StaticforNonComplexScriptsWithOptions

Parameters

Returns LineSegmenter

StaticforNonComplexScriptsWithOptionsAndProvider

Parameters

Returns LineSegmenter

StaticlstmWithOptions

Parameters

Returns LineSegmenter

StaticlstmWithOptionsAndProvider

Parameters

Returns LineSegmenter

segment

Parameters

Returns LineBreakIteratorUtf16

Settings

On This Page

`Static`autoWithOptions

`Static`autoWithOptionsAndProvider

`Static`createAuto

`Static`createDictionary

`Static`createForNonComplexScripts

`Static`createLstm

`Static`dictionaryWithOptions

`Static`dictionaryWithOptionsAndProvider

`Static`forNonComplexScriptsWithOptions

`Static`forNonComplexScriptsWithOptionsAndProvider

`Static`lstmWithOptions

`Static`lstmWithOptionsAndProvider