KeyboardInfoCompiler.run() method

Home > @keymanapp/kmc-keyboard-info > KeyboardInfoCompiler > run

KeyboardInfoCompiler.run() method

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/

Signature:

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

Parameters

Parameter	Type	Description
inputFilename	string
outputFilename	string	(Optional)

Returns:

Promise<KeyboardInfoCompilerResult>

Binary artifacts on success, null on failure.