Class CloudflarePlane

constructor

• new CloudflarePlane(options: CloudflareOptions): CloudflarePlane

  Parameters

  • options: CloudflareOptions

  Returns CloudflarePlane

ReadonlyaccountId

Readonlycapabilities

ReadonlycredentialKey

Readonlyhttp

Readonlykind

base

• get base(): string

  the path prefix every call here shares

  Returns string

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>

  the deployed modules, where the plane can return them

  Parameters

  • name: string

  Returns Promise<Response>

delete

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

  Parameters

  • name: string

  Returns Promise<void>

deleteSecret

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

  Parameters

  • name: string
  • secretName: string

  Returns Promise<void>

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[]>

  Parameters

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

  Returns Promise<WorkerSummary[]>

listSecrets

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

  Parameters

  • name: string

  Returns Promise<SecretSummary[]>

patchSettings

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

  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>

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>

upload

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

  Parameters

  • name: string
  • upload: BuiltUpload

  Returns Promise<UploadResult>