Skip to main content
The Worker component lets you deploy Cloudflare Workers to your app.

​
Constructor

sst.config.ts
const worker = new sst.cloudflare.Worker("MyWorker", {
  handler: "src/worker.ts",
  url: true
});

​
Parameters

​
handler

​
handler
string
required
Path to the worker handler file.
{
  handler: "src/worker.ts"
}

​
url

​
url
boolean
default:"false"
Enable a public URL for the worker.
{
  url: true
}
​
link
array
Link resources to the worker.
{
  link: [bucket, kv]
}

​
domain

​
domain
string | object
Set a custom domain for your worker.
{
  domain: "api.example.com"
}

​
Properties

​
url

​
nodes

​
SDK

Access linked resources in your worker:
src/worker.ts
import { Resource } from "sst";

export default {
  async fetch(request) {
    console.log(Resource.MyBucket.name);
    return new Response("Hello");
  }
};

​
Examples

​
Create a worker

sst.config.ts
new sst.cloudflare.Worker("MyWorker", {
  handler: "src/worker.ts",
  url: true
});

​
Add a custom domain

sst.config.ts
new sst.cloudflare.Worker("MyWorker", {
  handler: "src/worker.ts",
  domain: "api.example.com"
});
sst.config.ts
const kv = new sst.cloudflare.Kv("MyKv");

new sst.cloudflare.Worker("MyWorker", {
  handler: "src/worker.ts",
  link: [kv],
  url: true
});

Build docs developers (and LLMs) love

Get started for freeTalk to us