Keyboard Support

Contact and Search

Keyman.com Homepage

Header bottom

Keyman.com

Other versions
Version 19.0Version 18.0 (current version)

On this page

You are viewing an incomplete pre-release version of this documentation. Click here to open the current version, 18.0.

LexicalModelGenerator class

Home > @keymanapp/kmc-generate > LexicalModelGenerator

LexicalModelGenerator class

Generate a Keyman lexical model project. The generator does not read or write from filesystem or network directly, but relies on callbacks for all external IO.

Signature:

export declare class LexicalModelGenerator extends BasicGenerator implements KeymanCompiler 

Extends: BasicGenerator

Implements: KeymanCompiler

Properties

Property Modifiers Type Description
[SFile\_Model](./kmc-generate.lexicalmodelgenerator.sfile_model.md) `static` `readonly` (not declared)
[SFile\_ModelTs](./kmc-generate.lexicalmodelgenerator.sfile_modelts.md) `static` `readonly` string
[SFile\_Package](./kmc-generate.lexicalmodelgenerator.sfile_package.md) `static` `readonly` string
[SFile\_Project](./kmc-generate.lexicalmodelgenerator.sfile_project.md) `static` `readonly` string
[SFile\_WordlistTsv](./kmc-generate.lexicalmodelgenerator.sfile_wordlisttsv.md) `static` `readonly` string

Methods

Method Modifiers Description
[run()](./kmc-generate.lexicalmodelgenerator.run.md) Generate a Lexical Model project. Returns an object containing binary artifacts on success. The files are passed in by name, and the compiler will use callbacks as passed to the [AbstractGenerator.init()](./kmc-generate.abstractgenerator.init.md) function to read any input files by disk.