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-model.lexicalmodelcompiler.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.4 KiB
Raw Blame History

Home > @keymanapp/kmc-model > LexicalModelCompiler

LexicalModelCompiler class

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

Signature:

export declare class LexicalModelCompiler implements KeymanCompiler

Implements: KeymanCompiler

Methods

Method Modifiers Description
init(callbacks, _options) Initialize the compiler. There are currently no options specific to the lexical model compiler
run(inputFilename, outputFilename) Compiles a .model.ts file to .model.js. 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 LexicalModelCompiler.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:

- .model.js file - Javascript lexical model for web and touch platforms