Class WebLanguageModel

The main language model.

Implements

LanguageModel

Index

Constructors

Methods

addUserPhrase convertMacro filterAndTransformUnigrams getReading getUnigrams hasUnigrams setAddUserPhraseConverter setConverter setExcludedPhrases setMacroConverter setOnPhraseAdded setOnPhraseChange setUserPhrases maybeAbsoluteOrderKey

Constructors

constructor

new WebLanguageModel(map: any): WebLanguageModel
Parameters
- map: any
Returns WebLanguageModel
- Defined in McBopomofo/WebLanguageModel.ts:172

Methods

addUserPhrase

addUserPhrase(key: string, phrase: string): void
Adds user phrases.
Parameters
- key: string
  The key.
- phrase: string
  The phrase.
Returns void
- Defined in McBopomofo/WebLanguageModel.ts:165

convertMacro

convertMacro(input: string): string
Converts a macro.
Parameters
- input: string
Returns string
- Defined in McBopomofo/WebLanguageModel.ts:100

filterAndTransformUnigrams

filterAndTransformUnigrams(
    unigrams: Unigram[],
    excludedValues: Set<string>,
    insertedValues: Set<string>,
): Unigram[]
Parameters
- unigrams: Unigram[]
- excludedValues: Set<string>
- insertedValues: Set<string>
Returns Unigram[]
- Defined in McBopomofo/WebLanguageModel.ts:272

getReading

getReading(input: string): undefined | string
Parameters
- input: string
Returns undefined | string
- Defined in McBopomofo/WebLanguageModel.ts:334

getUnigrams

getUnigrams(key: string): Unigram[]
Retrieves an array of Unigram objects for the specified key.
Parameters
- key: string
  The string key to look up unigrams for
Returns Unigram[]
An array of Unigram objects matching the key
Implementation of LanguageModel.getUnigrams
- Defined in McBopomofo/WebLanguageModel.ts:176

hasUnigrams

hasUnigrams(key: string): boolean
Whether Unigrams exist for the specified key.
Parameters
- key: string
  The string key to look up unigrams for
Returns boolean
Whether Unigrams exist for the key
Implementation of LanguageModel.hasUnigrams
- Defined in McBopomofo/WebLanguageModel.ts:260

setAddUserPhraseConverter

setAddUserPhraseConverter(
converter?: (input: string) => undefined | string,
): void
Sets the string converter.
Parameters
- Optionalconverter: (input: string) => undefined | string
Returns void
- Defined in McBopomofo/WebLanguageModel.ts:107

setConverter

setConverter(converter?: (input: string) => undefined | string): void
Sets the string converter.
Parameters
- Optionalconverter: (input: string) => undefined | string
Returns void
- Defined in McBopomofo/WebLanguageModel.ts:95

setExcludedPhrases

setExcludedPhrases(map: Map<string, string[]>): void
Sets the excluded phrases.
Parameters
- map: Map<string, string[]>
Returns void
- Defined in McBopomofo/WebLanguageModel.ts:144

setMacroConverter

setMacroConverter(converter?: (input: string) => undefined | string): void
Sets the string converter.
Parameters
- Optionalconverter: (input: string) => undefined | string
Returns void
- Defined in McBopomofo/WebLanguageModel.ts:87

setOnPhraseAdded

setOnPhraseAdded(callback: (key: string, phrase: string) => void): void
Parameters
- callback: (key: string, phrase: string) => void
Returns void
- Defined in McBopomofo/WebLanguageModel.ts:154

setOnPhraseChange

setOnPhraseChange(callback: (map: Map<string, string[]>) => void): void
Parameters
- callback: (map: Map<string, string[]>) => void
Returns void
- Defined in McBopomofo/WebLanguageModel.ts:148

setUserPhrases

setUserPhrases(input: string | Map<string, string[]>): void
Sets the user phrases.
Parameters
- input: string | Map<string, string[]>
Returns void
- Defined in McBopomofo/WebLanguageModel.ts:114

`Static`maybeAbsoluteOrderKey

maybeAbsoluteOrderKey(key: string): string
Converts to an absolute-order key if needed.
Parameters
- key: string
  a key that KeyHandler uses
Returns string
an absolute-order key if it's not a punctuation key.
- Defined in McBopomofo/WebLanguageModel.ts:315