LdmlKeyboardCompiler.run() method

Home > @keymanapp/kmc-ldml > LdmlKeyboardCompiler > run

LdmlKeyboardCompiler.run() method

Compiles a LDML keyboard .xml 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 LdmlKeyboardCompiler.init() function to read any input files by disk.

Signature:

run(inputFilename: string, outputFilename?: string): Promise<LdmlKeyboardCompilerResult>;

Parameters

Parameter	Type	Description
inputFilename	string
outputFilename	string	(Optional)

Returns:

Promise<LdmlKeyboardCompilerResult>

Binary artifacts on success, null on failure.