KeymanKeyboardGenerator class

Home > @keymanapp/kmc-generate > KeymanKeyboardGenerator

KeymanKeyboardGenerator class

Generate a Keyman 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 KeymanKeyboardGenerator extends BasicGenerator implements KeymanCompiler 

Extends: BasicGenerator

Implements: KeymanCompiler

Properties

Property	Modifiers	Type	Description
SFile_Keyboard	static readonly	(not declared)
SFile_KeyboardKMN	static readonly	string
SFile_KeyboardKPS	static readonly	string
SFile_KeyboardKVKS	static readonly	string
SFile_Project	static readonly	string
SFile_TouchLayout	static readonly	string

Methods

Method	Modifiers	Description
run()		Generate a Keyman 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() function to read any input files by disk.