mirror of
https://github.com/keymanapp/keyman.git
synced 2026-09-09 17:17:41 +00:00
46 lines
1.5 KiB
TypeScript
46 lines
1.5 KiB
TypeScript
/**
|
|
* Interfaces and constants used by the lexical model compiler. These target
|
|
* the LMLayer's internal worker code, so we provide those definitions too.
|
|
*/
|
|
/// <reference path="../../../../common/predictive-text/worker/worker-compiler-interfaces.d.ts" />
|
|
|
|
interface LexicalModel {
|
|
readonly format: 'trie-1.0'|'fst-foma-1.0'|'custom-1.0',
|
|
//... metadata ...
|
|
}
|
|
|
|
interface LexicalModelSource extends LexicalModel {
|
|
readonly sources: Array<string>;
|
|
/**
|
|
* The name of the type to instantiate (without parameters) as the base object for a custom predictive model.
|
|
*/
|
|
readonly rootClass?: string
|
|
|
|
/**
|
|
* Which word breaker to use. Choose from:
|
|
*
|
|
* - 'default' -- breaks according to Unicode UAX #29 §4.1 Default Word
|
|
* Boundary Specification, which works well for *most* languages.
|
|
* - 'ascii' -- a very simple word breaker, for demonstration purposes only.
|
|
* - word breaking function -- provide your own function that breaks words.
|
|
* - class-based word-breaker - may be supported in the future.
|
|
*/
|
|
readonly wordBreaker?: 'default' | 'ascii' | WordBreakingFunction;
|
|
|
|
/**
|
|
* How to simplify words, to convert them into simplifired search keys
|
|
* This often involves removing accents, lowercasing, etc.
|
|
*/
|
|
readonly searchTermToKey?: (term: string) => string;
|
|
|
|
/**
|
|
* Punctuation and spacing suggested by the model.
|
|
*
|
|
* @see LexicalModelPunctuation
|
|
*/
|
|
readonly punctuation?: LexicalModelPunctuation;
|
|
}
|
|
|
|
interface LexicalModelCompiled extends LexicalModel {
|
|
readonly id: string;
|
|
}
|