Skip to main content

Class: WorkspaceMigration

A planned workspace migration.

Extends​

  • BaseClient

Constructors​

Constructor​

new WorkspaceMigration(ctx?, _id?): WorkspaceMigration

Constructor is used for internal usage only, do not create object from it.

Parameters​

ctx?​

Context

_id?​

ID

Returns​

WorkspaceMigration

Overrides​

BaseClient.constructor

Methods​

changes()​

changes(): Changeset

Filesystem changes for the full migration plan.

Returns​

Changeset

id()​

id(): Promise<ID>

A unique identifier for this WorkspaceMigration.

Returns​

Promise<ID>

steps()​

steps(): Promise<WorkspaceMigrationStep[]>

Logical migration steps, each identified by a stable code.

Returns​

Promise<WorkspaceMigrationStep[]>