Class Wrangler

constructor

• new Wrangler(root: string, env?: ProcessEnv): Wrangler

  Parameters

  • root: string
  • env: ProcessEnv = process.env

  Returns Wrangler

Static ReadonlyPACKAGE

Staticnode

• get node(): string

  Node.js, also when the CLI itself runs on Bun (Wrangler supports Node.js only).

  Returns string

command

• command(args: string[]): WranglerCommand

  Parameters

  • args: string[]

  Returns WranglerCommand

projectBin

• projectBin(): string | undefined

  The wrangler executable installed for the project, looked up like Node.js resolves packages.

  Returns string | undefined

run

• run(
      args: string[],
      relay: (chunk: string, stream: "stdout" | "stderr") => void,
  ): Promise<WranglerResult>

  Runs Wrangler in the project root without standard input; relay receives its output as it comes.

  Parameters

  • args: string[]
  • relay: (chunk: string, stream: "stdout" | "stderr") => void

  Returns Promise<WranglerResult>

StaticerrorOf

• errorOf(output: string): string

  The first error Wrangler reported (✘ [ERROR] ... and its indented continuation, e.g. a link), else its last line of output.

  Parameters

  • output: string

  Returns string

StaticisAuthError

• isAuthError(output: string): boolean

  Whether the failure is about missing or wrong Cloudflare credentials.

  Parameters

  • output: string

  Returns boolean

StaticisSubdomainError

• isSubdomainError(output: string): boolean

  Whether the account has no workers.dev subdomain yet, so a worker without routes has nowhere to go.

  Parameters

  • output: string

  Returns boolean