Keyboard Support

Contact and Search

Keyman.com Homepage

Header bottom

Keyman.com

Other versions
Version 18.0Version 17.0 (current version)

On this page

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) Initialize the compiler. There are currently no options specific to the lexical model compiler
run(inputFilename, outputFilename) 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() function to read any input files by disk.
write(artifacts)

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