Keyboard Support

Contact and Search

Keyman.com Homepage

Header bottom

Keyman.com

Other versions
Version 19.0Version 18.0 (current version)Version 17.0

On this page

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

LexicalModelCompiler class

Home > @keymanapp/kmc-model > LexicalModelCompiler

LexicalModelCompiler class

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.

Signature:

export declare class LexicalModelCompiler implements KeymanCompiler 

Implements: KeymanCompiler

Methods

Method Modifiers Description
[init(callbacks, \_options)](./kmc-model.lexicalmodelcompiler.init.md) Initialize the compiler. There are currently no options specific to the lexical model compiler
[run(inputFilename, outputFilename)](./kmc-model.lexicalmodelcompiler.run.md) Compiles a .model.ts file to .model.js. 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 [LexicalModelCompiler.init()](./kmc-model.lexicalmodelcompiler.init.md) function to read any input files by disk.
[write(artifacts)](./kmc-model.lexicalmodelcompiler.write.md) Write artifacts from a successful compile to disk, via callbacks methods. The artifacts written may include: - .model.js file - Javascript lexical model for web and touch platforms