Class DeployStore_v1

constructor

• new DeployStore_v1(storePath, defaults?): DeployStore_v1

• Parameters

  • storePath: string | Path | YAMLDirectory<unknown>

  • defaults: Partial<Deployment> = {}

  Returns DeployStore_v1

KEY

log

root

[toStringTag]

• get [toStringTag](): string

• Returns string

activeName

• get activeName(): null | string

• Returns null | string

  the name of the active deployment

create

• create(name?): Promise<DeploymentState>

• Create a deployment with a specific name.

  Parameters

  • name: string = ...

  Returns Promise<DeploymentState>

list

• list(): string[]

• List the deployments in the deployments directory.

  Returns string[]

load

• load(name?): DeploymentState

• Get the contents of the named deployment, or null if it doesn't exist.

  Parameters

  • name: undefined | null | string = ...

  Returns DeploymentState

save

• save(name, state?): DeployStore_v1

• Save a deployment's state to this store.

  Parameters

  • name: string

  • state: DeploymentState = {}

  Returns DeployStore_v1

select

• select(name?): Promise<DeploymentState>

• Make the specified deployment be the active deployment.

  Parameters

  • name: null | string = ...

  Returns Promise<DeploymentState>