Class CloudflareDeployment

Deploys the output of the cloudflare preset with Wrangler. plan runs wrangler deploy --dry-run, which bundles the worker and checks the configuration without uploading; apply runs wrangler deploy.

Index

Constructors

constructor

new CloudflareDeployment(context: DeployContext): CloudflareDeployment
Parameters
- context: DeployContext
Returns CloudflareDeployment
- Defined in dev-packages/cli/src/preset/cloudflare/cloudflare-deployer.ts:22

Properties

`Protected` `Readonly`context

context: DeployContext

`Protected` `Readonly`file

file: string

`Protected` `Readonly`wrangler

wrangler: Wrangler

`Static` `Readonly`AUTH_HINT

AUTH_HINT: "Set CLOUDFLARE_API_TOKEN (a token with the \"Edit Cloudflare Workers\" template; also CLOUDFLARE_ACCOUNT_ID if it can access several accounts), or run `npx wrangler login` once." = 'Set CLOUDFLARE_API_TOKEN (a token with the "Edit Cloudflare Workers" template; also CLOUDFLARE_ACCOUNT_ID if it can access several accounts), or run `npx wrangler login` once.'

`Static` `Readonly`SUBDOMAIN_HINT

SUBDOMAIN_HINT: "Register the workers.dev subdomain of the account once (open Workers & Pages in the Cloudflare dashboard, the link in the message), or deploy to your own domain with `routes` in wrangler.jsonc." = 'Register the workers.dev subdomain of the account once (open Workers & Pages in the Cloudflare dashboard, the link in the message), or deploy to your own domain with `routes` in wrangler.jsonc.'

Methods

apply

apply(_plan: DeployPlan): Promise<Deployment>
Parameters
- _plan: DeployPlan
Returns Promise<Deployment>
- Defined in dev-packages/cli/src/preset/cloudflare/cloudflare-deployer.ts:50

`Protected`failure

failure(code: string, step: string, output: string): CellError
Parameters
- code: string
- step: string
- output: string
Returns CellError
- Defined in dev-packages/cli/src/preset/cloudflare/cloudflare-deployer.ts:107

plan

plan(): Promise<DeployPlan>
Returns Promise<DeployPlan>
- Defined in dev-packages/cli/src/preset/cloudflare/cloudflare-deployer.ts:27

`Protected`readConfig

readConfig(): WranglerJson
Returns WranglerJson
- Defined in dev-packages/cli/src/preset/cloudflare/cloudflare-deployer.ts:69

`Protected` `Readonly`relay

relay(chunk: string, stream: "stdout" | "stderr"): any
Parameters
- chunk: string
- stream: "stdout" | "stderr"
Returns any
- Defined in dev-packages/cli/src/preset/cloudflare/cloudflare-deployer.ts:67

`Protected`resources

resources(config: WranglerJson, output: string): DeployResource[]
The worker and its assets, with the sizes Wrangler reported in the dry run.
Parameters
- config: WranglerJson
- output: string
Returns DeployResource[]
- Defined in dev-packages/cli/src/preset/cloudflare/cloudflare-deployer.ts:82

`Static`urlOf

urlOf(output: string): string | undefined
Where the worker answers: its first custom domain, else its workers.dev address (as Wrangler lists them after deploying).
Parameters
- output: string
Returns string | undefined
- Defined in dev-packages/cli/src/preset/cloudflare/cloudflare-deployer.ts:62

Class CloudflareDeployment

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns CloudflareDeployment

Properties

`Protected` `Readonly`context

`Protected` `Readonly`file

`Protected` `Readonly`wrangler

`Static` `Readonly`AUTH_HINT

`Static` `Readonly`SUBDOMAIN_HINT

Methods

apply

Parameters

Returns Promise<Deployment>

`Protected`failure

Parameters

Returns CellError

plan

Returns Promise<DeployPlan>

`Protected`readConfig

Returns WranglerJson

`Protected` `Readonly`relay

Parameters

Returns any

`Protected`resources

Parameters

Returns DeployResource[]

`Static`urlOf

Parameters

Returns string | undefined

Settings

On This Page

Class CloudflareDeployment

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns CloudflareDeployment

Properties

Protected Readonlycontext

Protected Readonlyfile

Protected Readonlywrangler

Static ReadonlyAUTH_HINT

Static ReadonlySUBDOMAIN_HINT

Methods

apply

Parameters

Returns Promise<Deployment>

Protectedfailure

Parameters

Returns CellError

plan

Returns Promise<DeployPlan>

ProtectedreadConfig

Returns WranglerJson

Protected Readonlyrelay

Parameters

Returns any

Protectedresources

Parameters

Returns DeployResource[]

StaticurlOf

Parameters

Returns string | undefined

Settings

On This Page

`Protected` `Readonly`context

`Protected` `Readonly`file

`Protected` `Readonly`wrangler

`Static` `Readonly`AUTH_HINT

`Static` `Readonly`SUBDOMAIN_HINT

`Protected`failure

`Protected`readConfig

`Protected` `Readonly`relay

`Protected`resources

`Static`urlOf