Class WorkerdPlane

constructor

• new WorkerdPlane(options: WorkerdOptions): WorkerdPlane

  Parameters

  • options: WorkerdOptions

  Returns WorkerdPlane

Readonlycapabilities

ReadonlycredentialKey

Readonlyendpoint

Readonlyhttp

Readonlykind

target

• get target(): string

  what this plane is, for an error message: an account id, a namespace, an endpoint

  Returns string

content

• content(name: string): Promise<Response>

  A node does not serve a deployed bundle back; the version id is an address, not a body.

  Parameters

  • name: string

  Returns Promise<Response>

create

• create(site: BastionSite): Promise<WorkerSummary>

  Registers a site. A bundle path and a probe have no default, so they are asked for here.

  Parameters

  • site: BastionSite

  Returns Promise<WorkerSummary>

delete

• delete(name: string): Promise<void>

  Removes a site. The route is session-only, so a node may refuse an API token here.

  Parameters

  • name: string

  Returns Promise<void>

deleteSecret

• deleteSecret(name: string, _secretName: string): Promise<void>

  Parameters

  • name: string
  • _secretName: string

  Returns Promise<void>

deployVersion

• deployVersion(name: string, version: string): Promise<BastionDeployment>

  Points a site at a version it already holds; no new version is created.

  Parameters

  • name: string
  • version: string

  Returns Promise<BastionDeployment>

exists

• exists(name: string): Promise<boolean>

  Parameters

  • name: string

  Returns Promise<boolean>

get

• get(name: string): Promise<WorkerSummary | null>

  Parameters

  • name: string

  Returns Promise<WorkerSummary | null>

list

• list(options?: { limit?: number }): Promise<WorkerSummary[]>

  every site this token may reach; one node answers in one page, so there is nothing to walk

  Parameters

  • options: { limit?: number } = {}

  Returns Promise<WorkerSummary[]>

listSecrets

• listSecrets(name: string): Promise<SecretSummary[]>

  Parameters

  • name: string

  Returns Promise<SecretSummary[]>

logs

• logs(
      options?: { level?: string; limit?: number; site?: string },
  ): Promise<BastionLogLine[]>

  The node's own log, which is what tails means here: it owns the process that wrote it.

  Parameters

  • options: { level?: string; limit?: number; site?: string } = {}

  Returns Promise<BastionLogLine[]>

metrics

• metrics(): Promise<string>

  The Prometheus exposition the node serves; text rather than JSON, so it skips the envelope.

  Returns Promise<string>

patchSettings

• patchSettings(
      name: string,
      settings: Partial<WorkerSettings>,
  ): Promise<WorkerSettings>

  Writes the site record back.

  POST /api/sites is the only write on a site record, so it is an upsert rather than a patch endpoint; the current record is read first and merged, or a partial change would drop the rest.

  Parameters

  • name: string
  • settings: Partial<WorkerSettings>

  Returns Promise<WorkerSettings>

putSecret

• putSecret(name: string, _secret: { name: string; text: string }): Promise<void>

  Parameters

  • name: string
  • _secret: { name: string; text: string }

  Returns Promise<void>

rollback

• rollback(name: string, version?: string): Promise<BastionDeployment>

  Moves the pointer back; naming a version picks it, leaving it out takes the previous one.

  Parameters

  • name: string
  • Optionalversion: string

  Returns Promise<BastionDeployment>

rollout

• rollout(
      name: string,
      version: string,
      percent: number,
  ): Promise<BastionDeployment>

  Sends a share of traffic to one version.

  A real split at the node's own front door, keyed per visitor rather than per request, so a session stays on one side of it for as long as the rollout lasts.

  Parameters

  • name: string
  • version: string
  • percent: number

  Returns Promise<BastionDeployment>

setTags

• setTags(name: string, tags: string[]): Promise<string[]>

  Parameters

  • name: string
  • tags: string[]

  Returns Promise<string[]>

settings

• settings(name: string): Promise<WorkerSettings>

  Parameters

  • name: string

  Returns Promise<WorkerSettings>

status

• status(): Promise<Record<string, unknown>>

  the node's own report: what it is running and how it is

  Returns Promise<Record<string, unknown>>

upload

• upload(name: string, upload: BuiltUpload): Promise<UploadResult>

  Deploys a bundle to a site that already exists.

  A site is a host, a bundle path and a probe, and an upload carries none of the three, so an unknown site is a named refusal from the node rather than a site invented from a Worker name.

  Parameters

  • name: string
  • upload: BuiltUpload

  Returns Promise<UploadResult>

versions

• versions(name: string): Promise<BastionVersion[]>

  Versions of one site, newest first.

  GET /api/versions answers for everything the token reaches, so the site filter is on the rows rather than on a query parameter.

  Parameters

  • name: string

  Returns Promise<BastionVersion[]>