KeymanProjectCopier class
Home > @keymanapp/kmc-copy > KeymanProjectCopier
KeymanProjectCopier class
Signature:
export declare class KeymanProjectCopier implements KeymanCompiler Implements: KeymanCompiler
Properties
| Property | Modifiers | Type | Description |
|---|---|---|---|
| asyncCallbacks | CopierAsyncCallbacks | ||
| callbacks | CompilerCallbacks | ||
| cloudSource | KeymanCloudSource | ||
| githubRef | GitHubRef | ||
| options | CopierOptions | ||
| outPath | string | ||
| outputId | string | ||
| relocateExternalFiles | boolean | ||
| sourceId | string |
Methods
| Method | Modifiers | Description |
|---|---|---|
| init(callbacks, options) | ||
| isLocalOrigin() | ||
| run(source) | 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. | |
| write(artifacts) | Write artifacts from a successful compile to disk, via callbacks methods. The artifacts written will include all files from the project, across multiple folders. Folders will be created as needed |
