KeyboardInfoCompiler class
Home > @keymanapp/kmc-keyboard-info > KeyboardInfoCompiler
KeyboardInfoCompiler class
Compiles source data from a keyboard project to a .keyboard_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 KeyboardInfoCompiler implements KeymanCompiler Implements: KeymanCompiler
Constructors
| Constructor | Modifiers | Description |
|---|---|---|
| (constructor)() | Constructs a new instance of the KeyboardInfoCompiler class |
Methods
| Method | Modifiers | Description |
|---|---|---|
| init(callbacks, options) | Initialize the compiler. Copies options. | |
| run(inputFilename, outputFilename) | Builds a .keyboard_info file with metadata from the keyboard 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 KeyboardInfoCompiler.init() function to read any input files by disk. This function is intended for use within the keyboards 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. For full documentation, see: https://help.keyman-staging.com/developer/cloud/keyboard\_info/ |
|
| write(artifacts) | Write artifacts from a successful compile to disk, via callbacks methods. The artifacts written may include: - .keyboard_info file - metadata file used by keyman.com |
