ModelInfoCompiler class
Home > @keymanapp/kmc-model-info > ModelInfoCompiler
ModelInfoCompiler class
Compiles source data from a lexical model project to a .model_info. The compiler does not read or write from filesystem or network directly, but relies on callbacks for all external IO.
Signature:
export declare class ModelInfoCompiler implements KeymanCompiler Implements: KeymanCompiler
Constructors
| Constructor | Modifiers | Description |
|---|---|---|
| (constructor)() | Constructs a new instance of the ModelInfoCompiler class |
Methods
| Method | Modifiers | Description |
|---|---|---|
| init(callbacks, options) | Initialize the compiler. Copies options. | |
| run(inputFilename, outputFilename) | Builds .model_info file with metadata from the model and package source file. 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 ModelInfoCompiler.init() function to read any input files by disk. This function is intended for use within the lexical-models repository. While many of the parameters could be deduced from each other, they are specified here to reduce the number of places the filenames are constructed. |
|
| write(artifacts) | Write artifacts from a successful compile to disk, via callbacks methods. The artifacts written may include: - .model_info file - metadata file used by keyman.com |
