LdmlKeyboardGenerator class
Home > @keymanapp/kmc-generate > LdmlKeyboardGenerator
LdmlKeyboardGenerator class
Generate a LDML keyboard project. The generator does not read or write from filesystem or network directly, but relies on callbacks for all external IO.
Signature:
export declare class LdmlKeyboardGenerator extends BasicGenerator implements KeymanCompiler Extends: BasicGenerator
Implements: KeymanCompiler
Properties
| Property | Modifiers | Type | Description |
|---|---|---|---|
| [SFile\_Keyboard](./kmc-generate.ldmlkeyboardgenerator.sfile_keyboard.md) | `protected` `static` `readonly` | (not declared) | |
| [SFile\_KeyboardXML](./kmc-generate.ldmlkeyboardgenerator.sfile_keyboardxml.md) | `static` `readonly` | string | |
| [SFile\_Package](./kmc-generate.ldmlkeyboardgenerator.sfile_package.md) | `static` `readonly` | string | |
| [SFile\_Project](./kmc-generate.ldmlkeyboardgenerator.sfile_project.md) | `static` `readonly` | string |
Methods
| Method | Modifiers | Description |
|---|---|---|
| [run()](./kmc-generate.ldmlkeyboardgenerator.run.md) | Generate a LDML Keyboard project. 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 [AbstractGenerator.init()](./kmc-generate.abstractgenerator.init.md) function to read any input files by disk. |
