Keyboard Support

Contact and Search

Keyman.com Homepage

Header bottom

Keyman.com

Other versions
Version 19.0Version 18.0 (current version)

On this page

You are viewing an incomplete pre-release version of this documentation. Click here to open the current version, 18.0.

KeymanProjectCopier.run() method

Home > @keymanapp/kmc-copy > KeymanProjectCopier > run

KeymanProjectCopier.run() method

Copy a Keyman project. 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 KeymanProjectCopier.init() function to read any input files by disk.

Signature:

run(source: string): Promise<CopierResult>;

Parameters

Parameter Type Description
source string Source file or folder to copy. Can be a local file or folder, https://github.com/.../repo\[/path], or cloud:id

Returns:

Promise<CopierResult>

Binary artifacts on success, null on failure.