Skip to content

platform/lifecycle

Documentation

Overview

Classes

Lifecycle

publish()

Publishes a project for a specific user and workspace.

ts
static publish(user: string, workspace: string, project: string): boolean;
ParameterTypeDescription
userstringThe username of the owner of the workspace.
workspacestringThe name of the workspace to publish from.
projectstringThe specific project name to publish. Use "*" to publish all projects in the workspace.

Returns

  • Type: boolean
  • Description: True if the publish operation was successful, false otherwise.

unpublish()

Unpublishes a currently deployed project.

ts
static unpublish(project: string): boolean;
ParameterTypeDescription
projectstringThe specific project name to unpublish. Use "*" to unpublish all currently deployed projects.

Returns

  • Type: boolean
  • Description: True if the unpublish operation was successful, false otherwise.