Class TitlecaseMapper

See the Rust documentation for TitlecaseMapper for more information.

Index

Constructors

Accessors

Methods

titlecaseSegment createWithProvider titlecaseSegmentWithCompiledData

Constructors

constructor

new TitlecaseMapper(): TitlecaseMapper
Returns TitlecaseMapper
- Defined in TitlecaseMapper.d.ts:44

Accessors

ffiValue

get ffiValue(): number
Returns number
- Defined in TitlecaseMapper.d.ts:16

Methods

titlecaseSegment

titlecaseSegment(
    s: string,
    locale: Locale,
    options: TitlecaseOptions_obj,
): string
Returns the full titlecase mapping of the given string

The v1 refers to the version of the options struct, which may change as we add more options

See the Rust documentation for titlecase_segment for more information.
Parameters
- s: string
- locale: Locale
- options: TitlecaseOptions_obj
Returns string
- Defined in TitlecaseMapper.d.ts:33

`Static`createWithProvider

createWithProvider(provider: DataProvider): TitlecaseMapper
Construct a new TitlecaseMapper instance using a particular data source.

See the Rust documentation for new for more information.
Parameters
- provider: DataProvider
Returns TitlecaseMapper
- Defined in TitlecaseMapper.d.ts:24

`Static`titlecaseSegmentWithCompiledData

titlecaseSegmentWithCompiledData(
    s: string,
    locale: Locale,
    options: TitlecaseOptions_obj,
): string
Returns the full titlecase mapping of the given string, using compiled data (avoids having to allocate a TitlecaseMapper object)

The v1 refers to the version of the options struct, which may change as we add more options

See the Rust documentation for titlecase_segment for more information.
Parameters
- s: string
- locale: Locale
- options: TitlecaseOptions_obj
Returns string
- Defined in TitlecaseMapper.d.ts:42