mirror of
https://github.com/keymanapp/keyman.git
synced 2026-08-05 16:35:33 +00:00
b751336c13
1. Copy help.keyman.com/developer/17.0/* into /developer/docs/help 2. Update references to 18.0 where appropriate 3. Copy all referenced images from /cdn/dev into /developer/docs/help/images and update links in documentation Next commit: add deployment to help-keyman-com.sh. Note: simplest way to test links at this point is to use the help.keyman.com auto deploy and wait for the PR on help.keyman.com to be validated; we could look at an internal link validation tool that verifies markdown links? Relates-to: #12347
1.8 KiB
1.8 KiB
Home > @keymanapp/kmc-kmn > KmnCompiler
KmnCompiler class
Compiles a .kmn file to a .kmx, .kvk, and/or .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 KmnCompiler implements KeymanCompiler, UnicodeSetParser
Implements: KeymanCompiler, UnicodeSetParser
Constructors
| Constructor | Modifiers | Description |
|---|---|---|
| (constructor)() | Constructs a new instance of the KmnCompiler class |
Methods
| Method | Modifiers | Description |
|---|---|---|
| init(callbacks, options) | Initialize the compiler, including loading the WASM host for kmcmplib. Copies options. | |
| run(infile, outfile) | Compiles a .kmn file to .kmx, .kvk, and/or .js files. 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 KmnCompiler.init() function to read any input files by disk. | |
| verifyInitialized() | Verify that wasm is spun up OK. | |
| write(artifacts) | Write artifacts from a successful compile to disk, via callbacks methods. The artifacts written may include: - .kmx file - binary keyboard used by Keyman on desktop platforms - .kvk file - binary on screen keyboard used by Keyman on desktop platforms - .js file - Javascript keyboard for web and touch platforms |