spiegel-keyman/developer/docs/help/reference/api/kmc-kmn.kmncompiler.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.2 KiB

Home > @keymanapp/kmc-kmn > KmnCompiler > run

KmnCompiler.run() method

Compiles a .kmn 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 KmnCompiler.init() function to read any input files by disk.

Signature:

run(infile: string, outfile: string): Promise<KmnCompilerResult>;

Parameters

Parameter Type Description
infile string Path to source file. Path will be parsed to find relative references in the .kmn file, such as icon or On Screen Keyboard file
outfile string Path to output file. The file will not be written to, but will be included in the result for use by KmnCompiler.write().

Returns:

Promise<KmnCompilerResult>

Binary artifacts on success, null on failure.