spiegel-keyman/developer/docs/help/reference/api/kmc-model-info.modelinfocompiler.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.3 KiB

Home > @keymanapp/kmc-model-info > ModelInfoCompiler > run

ModelInfoCompiler.run() method

Builds .model_info file with metadata from the model 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 ModelInfoCompiler.init() function to read any input files by disk.

This function is intended for use within the lexical-models 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.

Signature:

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

Parameters

Parameter Type Description
inputFilename string
outputFilename string (Optional)

Returns:

Promise<ModelInfoCompilerResult>

Binary artifacts on success, null on failure.