Skip to main content

Class: WorkspaceMigrationStep

A single logical part of a workspace migration.

Extends​

  • BaseClient

Constructors​

Constructor​

new WorkspaceMigrationStep(ctx?, _id?, _code?, _description?): WorkspaceMigrationStep

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

Parameters​

ctx?​

Context

_id?​

ID

_code?​

string

_description?​

string

Returns​

WorkspaceMigrationStep

Overrides​

BaseClient.constructor

Methods​

changes()​

changes(): Changeset

Filesystem changes for this step.

Returns​

Changeset

code()​

code(): Promise<string>

Stable code identifying this logical migration step.

Returns​

Promise<string>

description()​

description(): Promise<string>

Generic summary of this step's purpose and impact.

Returns​

Promise<string>

id()​

id(): Promise<ID>

A unique identifier for this WorkspaceMigrationStep.

Returns​

Promise<ID>

warnings()​

warnings(): Promise<string[]>

Non-fatal warnings raised while planning this step.

Returns​

Promise<string[]>