Keyboard Support

Contact and Search

Keyman.com Homepage

Header bottom

Keyman.com

Other versions
Version 18.0Version 17.0 (current version)

On this page

LdmlKeyboardCompiler.write() method

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

LdmlKeyboardCompiler.write() method

Write artifacts from a successful compile to disk, via callbacks methods. The artifacts written may include:

  • .kmx file - binary keyboard used by Keyman on desktop platforms - .kvk file - binary on screen keyboard used by Keyman on desktop platforms - .js file - Javascript keyboard for web and touch platforms

Signature:

write(artifacts: LdmlKeyboardCompilerArtifacts): Promise<boolean>;

Parameters

Parameter Type Description
artifacts LdmlKeyboardCompilerArtifacts object containing artifact binary data to write out

Returns:

Promise<boolean>

true on success