spiegel-keyman/developer/docs/help/reference/api/kmc-model.md
Marc Durdin b751336c13 refactor(developer): copy dev 17.0 help into repo
1. Copy help.keyman.com/developer/17.0/* into /developer/docs/help
2. Update references to 18.0 where appropriate
3. Copy all referenced images from /cdn/dev into
   /developer/docs/help/images and update links in documentation

Next commit: add deployment to help-keyman-com.sh. Note: simplest way to
test links at this point is to use the help.keyman.com auto deploy and
wait for the PR on help.keyman.com to be validated; we could look at an
internal link validation tool that verifies markdown links?

Relates-to: #12347
2024-09-16 08:46:24 +07:00

30 lines
1.8 KiB
Markdown

<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [@keymanapp/kmc-model](./kmc-model.md)
## kmc-model package
## Classes
| Class | Description |
| --- | --- |
| [LexicalModelCompiler](./kmc-model.lexicalmodelcompiler.md) | Compiles a .model.ts file to a .model.js. The compiler does not read or write from filesystem or network directly, but relies on callbacks for all external IO. |
## Interfaces
| Interface | Description |
| --- | --- |
| [LexicalModelCompilerArtifacts](./kmc-model.lexicalmodelcompilerartifacts.md) | Internal in-memory build artifacts from a successful compilation |
| [LexicalModelCompilerResult](./kmc-model.lexicalmodelcompilerresult.md) | Build artifacts from the lexical model compiler |
| [LexicalModelSource](./kmc-model.lexicalmodelsource.md) | Base interface for a lexical model source definition |
| [WordBreakerSpec](./kmc-model.wordbreakerspec.md) | <p>Keyman 14.0+ word breaker specification:</p><p>Can support all old word breaking specification, but can also be extended with options.</p><p> 14.0</p> |
## Type Aliases
| Type Alias | Description |
| --- | --- |
| [CasedWordformToKeySpec](./kmc-model.casedwordformtokeyspec.md) | Simplifies input text to facilitate finding entries within a lexical model's lexicon, using the model's <code>applyCasing</code> function to assist in the keying process. 14.0 |
| [SimpleWordBreakerSpec](./kmc-model.simplewordbreakerspec.md) | <p>Simplified word breaker specification.</p><p> 11.0</p> |
| [SimpleWordformToKeySpec](./kmc-model.simplewordformtokeyspec.md) | Simplifies input text to facilitate finding entries within a lexical model's lexicon. 11.0 |
| [WordformToKeySpec](./kmc-model.wordformtokeyspec.md) | Simplifies input text to facilitate finding entries within a lexical model's lexicon. |