KeymanProjectCopier class
Home > @keymanapp/kmc-copy > KeymanProjectCopier
KeymanProjectCopier class
Copy a project and rename internal references
Signature:
export declare class KeymanProjectCopier implements KeymanCompiler Implements: KeymanCompiler
Properties
| Property | Modifiers | Type | Description |
|---|---|---|---|
| [asyncCallbacks](./kmc-copy.keymanprojectcopier.asynccallbacks.md) | CopierAsyncCallbacks | ||
| [callbacks](./kmc-copy.keymanprojectcopier.callbacks.md) | CompilerCallbacks | ||
| [cloudSource](./kmc-copy.keymanprojectcopier.cloudsource.md) | KeymanCloudSource | ||
| [githubRef](./kmc-copy.keymanprojectcopier.githubref.md) | GitHubRef | ||
| [options](./kmc-copy.keymanprojectcopier.options.md) | [CopierOptions](./kmc-copy.copieroptions.md) | ||
| [outPath](./kmc-copy.keymanprojectcopier.outpath.md) | string | ||
| [outputId](./kmc-copy.keymanprojectcopier.outputid.md) | string | ||
| [sourceId](./kmc-copy.keymanprojectcopier.sourceid.md) | string |
Methods
| Method | Modifiers | Description |
|---|---|---|
| [init(callbacks, options)](./kmc-copy.keymanprojectcopier.init.md) | ||
| [isLocalOrigin()](./kmc-copy.keymanprojectcopier.islocalorigin.md) | ||
| [run(source)](./kmc-copy.keymanprojectcopier.run.md) | 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()](./kmc-copy.keymanprojectcopier.init.md) function to read any input files by disk. | |
| [write(artifacts)](./kmc-copy.keymanprojectcopier.write.md) | 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 |
