erabo/spiegel-keyman
1
0
Fork 0
mirror of https://github.com/keymanapp/keyman.git synced 2026-08-05 16:35:33 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 13
spiegel-keyman/developer/docs/help/reference/api/kmc-ldml.ldmlkeyboardcompiler.run.md
Marc Durdin b751336c13 refactor(developer): copy dev 17.0 help into repo 
1. Copy help.keyman.com/developer/17.0/* into /developer/docs/help
2. Update references to 18.0 where appropriate
3. Copy all referenced images from /cdn/dev into
   /developer/docs/help/images and update links in documentation

Next commit: add deployment to help-keyman-com.sh. Note: simplest way to
test links at this point is to use the help.keyman.com auto deploy and
wait for the PR on help.keyman.com to be validated; we could look at an
internal link validation tool that verifies markdown links?

Relates-to: #12347
2024-09-16 08:46:24 +07:00

1,000 B
Raw Blame History

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.