Keyboard Support

Contact and Search

Keyman.com Homepage

Header bottom

Keyman.com

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

On this page

LexicalModelCompiler.run() method

Home > @keymanapp/kmc-model > LexicalModelCompiler > run

LexicalModelCompiler.run() method

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.

Signature:

run(inputFilename: string, outputFilename?: string): Promise<LexicalModelCompilerResult>;

Parameters

Parameter Type Description
inputFilename string
outputFilename string (Optional)

Returns:

Promise<LexicalModelCompilerResult>

Binary artifacts on success, null on failure.