KmpCompiler class

Home > @keymanapp/kmc-package > KmpCompiler

KmpCompiler class

Compiles a .kps file to a .kmp archive. The compiler does not read or write from filesystem or network directly, but relies on callbacks for all external IO.

Signature:

export declare class KmpCompiler implements KeymanCompiler 

Implements: KeymanCompiler

Properties

Property	Modifiers	Type	Description
normalizePath	readonly	(path: string) => string

Methods

Method	Modifiers	Description
init(callbacks, options)		Initialize the compiler. Copies options.
run(inputFilename, outputFilename)		Compiles a .kps file to .kmp 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 KmpCompiler.init() function to read any input files by disk.
write(artifacts)		Write artifacts from a successful compile to disk, via callbacks methods. The artifacts written may include: - .kmp file - binary keyboard package used by Keyman on desktop and touch platforms