pi-cloudflare 0.1.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/LICENSE +674 -0
- package/README.md +67 -0
- package/bin/setup.mjs +103 -0
- package/dist/auth-flow.d.ts +15 -0
- package/dist/auth-flow.d.ts.map +1 -0
- package/dist/auth-flow.js +90 -0
- package/dist/auth-flow.js.map +1 -0
- package/dist/client.d.ts +18 -0
- package/dist/client.d.ts.map +1 -0
- package/dist/client.js +47 -0
- package/dist/client.js.map +1 -0
- package/dist/config.d.ts +13 -0
- package/dist/config.d.ts.map +1 -0
- package/dist/config.js +10 -0
- package/dist/config.js.map +1 -0
- package/dist/index.d.ts +24 -0
- package/dist/index.d.ts.map +1 -0
- package/dist/index.js +109 -0
- package/dist/index.js.map +1 -0
- package/dist/oauth.d.ts +44 -0
- package/dist/oauth.d.ts.map +1 -0
- package/dist/oauth.js +135 -0
- package/dist/oauth.js.map +1 -0
- package/dist/proxy.d.ts +29 -0
- package/dist/proxy.d.ts.map +1 -0
- package/dist/proxy.js +39 -0
- package/dist/proxy.js.map +1 -0
- package/dist/servers.d.ts +19 -0
- package/dist/servers.d.ts.map +1 -0
- package/dist/servers.js +40 -0
- package/dist/servers.js.map +1 -0
- package/dist/token-store.d.ts +23 -0
- package/dist/token-store.d.ts.map +1 -0
- package/dist/token-store.js +47 -0
- package/dist/token-store.js.map +1 -0
- package/package.json +67 -0
- package/skills/agents-sdk/SKILL.md +221 -0
- package/skills/agents-sdk/references/browse-the-web.md +63 -0
- package/skills/agents-sdk/references/callable.md +92 -0
- package/skills/agents-sdk/references/client-sdk.md +110 -0
- package/skills/agents-sdk/references/codemode.md +110 -0
- package/skills/agents-sdk/references/configuration.md +72 -0
- package/skills/agents-sdk/references/durable-execution.md +51 -0
- package/skills/agents-sdk/references/email.md +146 -0
- package/skills/agents-sdk/references/human-in-the-loop.md +67 -0
- package/skills/agents-sdk/references/mcp.md +188 -0
- package/skills/agents-sdk/references/observability.md +44 -0
- package/skills/agents-sdk/references/queue-retries.md +79 -0
- package/skills/agents-sdk/references/routing.md +75 -0
- package/skills/agents-sdk/references/server-driven-messages.md +63 -0
- package/skills/agents-sdk/references/state-scheduling.md +171 -0
- package/skills/agents-sdk/references/streaming-chat.md +198 -0
- package/skills/agents-sdk/references/think.md +112 -0
- package/skills/agents-sdk/references/voice.md +68 -0
- package/skills/agents-sdk/references/webhooks-push.md +86 -0
- package/skills/agents-sdk/references/workflows.md +132 -0
- package/skills/cloudflare/SKILL.md +248 -0
- package/skills/cloudflare/references/agents-sdk/README.md +89 -0
- package/skills/cloudflare/references/agents-sdk/api.md +190 -0
- package/skills/cloudflare/references/agents-sdk/configuration.md +182 -0
- package/skills/cloudflare/references/agents-sdk/gotchas.md +158 -0
- package/skills/cloudflare/references/agents-sdk/patterns.md +192 -0
- package/skills/cloudflare/references/ai-gateway/README.md +175 -0
- package/skills/cloudflare/references/ai-gateway/configuration.md +111 -0
- package/skills/cloudflare/references/ai-gateway/dynamic-routing.md +82 -0
- package/skills/cloudflare/references/ai-gateway/features.md +96 -0
- package/skills/cloudflare/references/ai-gateway/sdk-integration.md +114 -0
- package/skills/cloudflare/references/ai-gateway/troubleshooting.md +88 -0
- package/skills/cloudflare/references/ai-search/README.md +138 -0
- package/skills/cloudflare/references/ai-search/api.md +87 -0
- package/skills/cloudflare/references/ai-search/configuration.md +88 -0
- package/skills/cloudflare/references/ai-search/gotchas.md +81 -0
- package/skills/cloudflare/references/ai-search/patterns.md +85 -0
- package/skills/cloudflare/references/analytics-engine/README.md +94 -0
- package/skills/cloudflare/references/analytics-engine/api.md +112 -0
- package/skills/cloudflare/references/analytics-engine/configuration.md +112 -0
- package/skills/cloudflare/references/analytics-engine/gotchas.md +85 -0
- package/skills/cloudflare/references/analytics-engine/patterns.md +83 -0
- package/skills/cloudflare/references/api/README.md +66 -0
- package/skills/cloudflare/references/api/api.md +204 -0
- package/skills/cloudflare/references/api/configuration.md +160 -0
- package/skills/cloudflare/references/api/gotchas.md +225 -0
- package/skills/cloudflare/references/api/patterns.md +204 -0
- package/skills/cloudflare/references/api-shield/README.md +44 -0
- package/skills/cloudflare/references/api-shield/api.md +141 -0
- package/skills/cloudflare/references/api-shield/configuration.md +192 -0
- package/skills/cloudflare/references/api-shield/gotchas.md +125 -0
- package/skills/cloudflare/references/api-shield/patterns.md +180 -0
- package/skills/cloudflare/references/argo-smart-routing/README.md +90 -0
- package/skills/cloudflare/references/argo-smart-routing/api.md +240 -0
- package/skills/cloudflare/references/argo-smart-routing/configuration.md +197 -0
- package/skills/cloudflare/references/argo-smart-routing/gotchas.md +111 -0
- package/skills/cloudflare/references/argo-smart-routing/patterns.md +104 -0
- package/skills/cloudflare/references/artifacts/README.md +79 -0
- package/skills/cloudflare/references/artifacts/api.md +128 -0
- package/skills/cloudflare/references/artifacts/configuration.md +92 -0
- package/skills/cloudflare/references/bindings/README.md +122 -0
- package/skills/cloudflare/references/bindings/api.md +203 -0
- package/skills/cloudflare/references/bindings/configuration.md +188 -0
- package/skills/cloudflare/references/bindings/gotchas.md +208 -0
- package/skills/cloudflare/references/bindings/patterns.md +200 -0
- package/skills/cloudflare/references/bot-management/README.md +94 -0
- package/skills/cloudflare/references/bot-management/api.md +169 -0
- package/skills/cloudflare/references/bot-management/configuration.md +163 -0
- package/skills/cloudflare/references/bot-management/gotchas.md +114 -0
- package/skills/cloudflare/references/bot-management/patterns.md +182 -0
- package/skills/cloudflare/references/browser-rendering/README.md +78 -0
- package/skills/cloudflare/references/browser-rendering/api.md +108 -0
- package/skills/cloudflare/references/browser-rendering/configuration.md +78 -0
- package/skills/cloudflare/references/browser-rendering/gotchas.md +88 -0
- package/skills/cloudflare/references/browser-rendering/patterns.md +91 -0
- package/skills/cloudflare/references/c3/README.md +111 -0
- package/skills/cloudflare/references/c3/api.md +71 -0
- package/skills/cloudflare/references/c3/configuration.md +81 -0
- package/skills/cloudflare/references/c3/gotchas.md +92 -0
- package/skills/cloudflare/references/c3/patterns.md +82 -0
- package/skills/cloudflare/references/cache-reserve/README.md +147 -0
- package/skills/cloudflare/references/cache-reserve/api.md +194 -0
- package/skills/cloudflare/references/cache-reserve/configuration.md +169 -0
- package/skills/cloudflare/references/cache-reserve/gotchas.md +132 -0
- package/skills/cloudflare/references/cache-reserve/patterns.md +197 -0
- package/skills/cloudflare/references/containers/README.md +85 -0
- package/skills/cloudflare/references/containers/api.md +187 -0
- package/skills/cloudflare/references/containers/configuration.md +188 -0
- package/skills/cloudflare/references/containers/gotchas.md +178 -0
- package/skills/cloudflare/references/containers/patterns.md +202 -0
- package/skills/cloudflare/references/cron-triggers/README.md +99 -0
- package/skills/cloudflare/references/cron-triggers/api.md +196 -0
- package/skills/cloudflare/references/cron-triggers/configuration.md +180 -0
- package/skills/cloudflare/references/cron-triggers/gotchas.md +199 -0
- package/skills/cloudflare/references/cron-triggers/patterns.md +190 -0
- package/skills/cloudflare/references/d1/README.md +133 -0
- package/skills/cloudflare/references/d1/api.md +196 -0
- package/skills/cloudflare/references/d1/configuration.md +191 -0
- package/skills/cloudflare/references/d1/gotchas.md +98 -0
- package/skills/cloudflare/references/d1/patterns.md +189 -0
- package/skills/cloudflare/references/ddos/README.md +41 -0
- package/skills/cloudflare/references/ddos/api.md +164 -0
- package/skills/cloudflare/references/ddos/configuration.md +93 -0
- package/skills/cloudflare/references/ddos/gotchas.md +107 -0
- package/skills/cloudflare/references/ddos/patterns.md +174 -0
- package/skills/cloudflare/references/do-storage/README.md +75 -0
- package/skills/cloudflare/references/do-storage/api.md +102 -0
- package/skills/cloudflare/references/do-storage/configuration.md +112 -0
- package/skills/cloudflare/references/do-storage/gotchas.md +150 -0
- package/skills/cloudflare/references/do-storage/patterns.md +194 -0
- package/skills/cloudflare/references/do-storage/testing.md +183 -0
- package/skills/cloudflare/references/durable-objects/README.md +185 -0
- package/skills/cloudflare/references/durable-objects/api.md +187 -0
- package/skills/cloudflare/references/durable-objects/configuration.md +160 -0
- package/skills/cloudflare/references/durable-objects/gotchas.md +197 -0
- package/skills/cloudflare/references/durable-objects/patterns.md +201 -0
- package/skills/cloudflare/references/email-routing/README.md +89 -0
- package/skills/cloudflare/references/email-routing/api.md +195 -0
- package/skills/cloudflare/references/email-routing/configuration.md +186 -0
- package/skills/cloudflare/references/email-routing/gotchas.md +196 -0
- package/skills/cloudflare/references/email-routing/patterns.md +229 -0
- package/skills/cloudflare/references/email-workers/README.md +151 -0
- package/skills/cloudflare/references/email-workers/api.md +237 -0
- package/skills/cloudflare/references/email-workers/configuration.md +112 -0
- package/skills/cloudflare/references/email-workers/gotchas.md +125 -0
- package/skills/cloudflare/references/email-workers/patterns.md +102 -0
- package/skills/cloudflare/references/flagship/README.md +59 -0
- package/skills/cloudflare/references/flagship/api.md +390 -0
- package/skills/cloudflare/references/flagship/configuration.md +202 -0
- package/skills/cloudflare/references/flagship/gotchas.md +178 -0
- package/skills/cloudflare/references/flagship/patterns.md +469 -0
- package/skills/cloudflare/references/graphql-api/README.md +147 -0
- package/skills/cloudflare/references/graphql-api/api.md +175 -0
- package/skills/cloudflare/references/graphql-api/configuration.md +118 -0
- package/skills/cloudflare/references/graphql-api/gotchas.md +110 -0
- package/skills/cloudflare/references/graphql-api/patterns.md +225 -0
- package/skills/cloudflare/references/hyperdrive/README.md +82 -0
- package/skills/cloudflare/references/hyperdrive/api.md +143 -0
- package/skills/cloudflare/references/hyperdrive/configuration.md +159 -0
- package/skills/cloudflare/references/hyperdrive/gotchas.md +77 -0
- package/skills/cloudflare/references/hyperdrive/patterns.md +190 -0
- package/skills/cloudflare/references/images/README.md +61 -0
- package/skills/cloudflare/references/images/api.md +96 -0
- package/skills/cloudflare/references/images/configuration.md +211 -0
- package/skills/cloudflare/references/images/gotchas.md +99 -0
- package/skills/cloudflare/references/images/patterns.md +115 -0
- package/skills/cloudflare/references/kv/README.md +89 -0
- package/skills/cloudflare/references/kv/api.md +160 -0
- package/skills/cloudflare/references/kv/configuration.md +144 -0
- package/skills/cloudflare/references/kv/gotchas.md +131 -0
- package/skills/cloudflare/references/kv/patterns.md +196 -0
- package/skills/cloudflare/references/miniflare/README.md +105 -0
- package/skills/cloudflare/references/miniflare/api.md +187 -0
- package/skills/cloudflare/references/miniflare/configuration.md +173 -0
- package/skills/cloudflare/references/miniflare/gotchas.md +160 -0
- package/skills/cloudflare/references/miniflare/patterns.md +181 -0
- package/skills/cloudflare/references/network-interconnect/README.md +99 -0
- package/skills/cloudflare/references/network-interconnect/api.md +199 -0
- package/skills/cloudflare/references/network-interconnect/configuration.md +114 -0
- package/skills/cloudflare/references/network-interconnect/gotchas.md +165 -0
- package/skills/cloudflare/references/network-interconnect/patterns.md +166 -0
- package/skills/cloudflare/references/observability/README.md +88 -0
- package/skills/cloudflare/references/observability/api.md +164 -0
- package/skills/cloudflare/references/observability/configuration.md +169 -0
- package/skills/cloudflare/references/observability/gotchas.md +115 -0
- package/skills/cloudflare/references/observability/patterns.md +105 -0
- package/skills/cloudflare/references/pages/README.md +88 -0
- package/skills/cloudflare/references/pages/api.md +204 -0
- package/skills/cloudflare/references/pages/configuration.md +201 -0
- package/skills/cloudflare/references/pages/gotchas.md +203 -0
- package/skills/cloudflare/references/pages/patterns.md +204 -0
- package/skills/cloudflare/references/pages-functions/README.md +98 -0
- package/skills/cloudflare/references/pages-functions/api.md +143 -0
- package/skills/cloudflare/references/pages-functions/configuration.md +122 -0
- package/skills/cloudflare/references/pages-functions/gotchas.md +94 -0
- package/skills/cloudflare/references/pages-functions/patterns.md +137 -0
- package/skills/cloudflare/references/pipelines/README.md +90 -0
- package/skills/cloudflare/references/pipelines/api.md +124 -0
- package/skills/cloudflare/references/pipelines/configuration.md +155 -0
- package/skills/cloudflare/references/pipelines/gotchas.md +58 -0
- package/skills/cloudflare/references/pipelines/patterns.md +130 -0
- package/skills/cloudflare/references/pulumi/README.md +100 -0
- package/skills/cloudflare/references/pulumi/api.md +200 -0
- package/skills/cloudflare/references/pulumi/configuration.md +198 -0
- package/skills/cloudflare/references/pulumi/gotchas.md +181 -0
- package/skills/cloudflare/references/pulumi/patterns.md +191 -0
- package/skills/cloudflare/references/queues/README.md +96 -0
- package/skills/cloudflare/references/queues/api.md +206 -0
- package/skills/cloudflare/references/queues/configuration.md +144 -0
- package/skills/cloudflare/references/queues/gotchas.md +206 -0
- package/skills/cloudflare/references/queues/patterns.md +220 -0
- package/skills/cloudflare/references/r2/README.md +95 -0
- package/skills/cloudflare/references/r2/api.md +200 -0
- package/skills/cloudflare/references/r2/configuration.md +165 -0
- package/skills/cloudflare/references/r2/gotchas.md +190 -0
- package/skills/cloudflare/references/r2/patterns.md +193 -0
- package/skills/cloudflare/references/r2-data-catalog/README.md +75 -0
- package/skills/cloudflare/references/r2-data-catalog/api.md +122 -0
- package/skills/cloudflare/references/r2-data-catalog/configuration.md +98 -0
- package/skills/cloudflare/references/r2-data-catalog/gotchas.md +55 -0
- package/skills/cloudflare/references/r2-data-catalog/patterns.md +122 -0
- package/skills/cloudflare/references/r2-sql/README.md +64 -0
- package/skills/cloudflare/references/r2-sql/api.md +121 -0
- package/skills/cloudflare/references/r2-sql/configuration.md +50 -0
- package/skills/cloudflare/references/r2-sql/gotchas.md +39 -0
- package/skills/cloudflare/references/r2-sql/patterns.md +118 -0
- package/skills/cloudflare/references/realtime-sfu/README.md +65 -0
- package/skills/cloudflare/references/realtime-sfu/api.md +158 -0
- package/skills/cloudflare/references/realtime-sfu/configuration.md +137 -0
- package/skills/cloudflare/references/realtime-sfu/gotchas.md +133 -0
- package/skills/cloudflare/references/realtime-sfu/patterns.md +174 -0
- package/skills/cloudflare/references/realtimekit/README.md +113 -0
- package/skills/cloudflare/references/realtimekit/api.md +212 -0
- package/skills/cloudflare/references/realtimekit/configuration.md +203 -0
- package/skills/cloudflare/references/realtimekit/gotchas.md +169 -0
- package/skills/cloudflare/references/realtimekit/patterns.md +223 -0
- package/skills/cloudflare/references/sandbox/README.md +96 -0
- package/skills/cloudflare/references/sandbox/api.md +198 -0
- package/skills/cloudflare/references/sandbox/configuration.md +143 -0
- package/skills/cloudflare/references/sandbox/gotchas.md +194 -0
- package/skills/cloudflare/references/sandbox/patterns.md +201 -0
- package/skills/cloudflare/references/secrets-store/README.md +74 -0
- package/skills/cloudflare/references/secrets-store/api.md +200 -0
- package/skills/cloudflare/references/secrets-store/configuration.md +185 -0
- package/skills/cloudflare/references/secrets-store/gotchas.md +97 -0
- package/skills/cloudflare/references/secrets-store/patterns.md +207 -0
- package/skills/cloudflare/references/smart-placement/README.md +138 -0
- package/skills/cloudflare/references/smart-placement/api.md +183 -0
- package/skills/cloudflare/references/smart-placement/configuration.md +196 -0
- package/skills/cloudflare/references/smart-placement/gotchas.md +174 -0
- package/skills/cloudflare/references/smart-placement/patterns.md +183 -0
- package/skills/cloudflare/references/snippets/README.md +68 -0
- package/skills/cloudflare/references/snippets/api.md +198 -0
- package/skills/cloudflare/references/snippets/configuration.md +227 -0
- package/skills/cloudflare/references/snippets/gotchas.md +86 -0
- package/skills/cloudflare/references/snippets/patterns.md +135 -0
- package/skills/cloudflare/references/spectrum/README.md +52 -0
- package/skills/cloudflare/references/spectrum/api.md +181 -0
- package/skills/cloudflare/references/spectrum/configuration.md +194 -0
- package/skills/cloudflare/references/spectrum/gotchas.md +145 -0
- package/skills/cloudflare/references/spectrum/patterns.md +196 -0
- package/skills/cloudflare/references/static-assets/README.md +65 -0
- package/skills/cloudflare/references/static-assets/api.md +199 -0
- package/skills/cloudflare/references/static-assets/configuration.md +186 -0
- package/skills/cloudflare/references/static-assets/gotchas.md +162 -0
- package/skills/cloudflare/references/static-assets/patterns.md +189 -0
- package/skills/cloudflare/references/stream/README.md +114 -0
- package/skills/cloudflare/references/stream/api-live.md +195 -0
- package/skills/cloudflare/references/stream/api.md +199 -0
- package/skills/cloudflare/references/stream/configuration.md +141 -0
- package/skills/cloudflare/references/stream/gotchas.md +130 -0
- package/skills/cloudflare/references/stream/patterns.md +184 -0
- package/skills/cloudflare/references/tail-workers/README.md +89 -0
- package/skills/cloudflare/references/tail-workers/api.md +200 -0
- package/skills/cloudflare/references/tail-workers/configuration.md +176 -0
- package/skills/cloudflare/references/tail-workers/gotchas.md +192 -0
- package/skills/cloudflare/references/tail-workers/patterns.md +180 -0
- package/skills/cloudflare/references/terraform/README.md +102 -0
- package/skills/cloudflare/references/terraform/api.md +178 -0
- package/skills/cloudflare/references/terraform/configuration.md +197 -0
- package/skills/cloudflare/references/terraform/gotchas.md +150 -0
- package/skills/cloudflare/references/terraform/patterns.md +174 -0
- package/skills/cloudflare/references/tunnel/README.md +129 -0
- package/skills/cloudflare/references/tunnel/api.md +193 -0
- package/skills/cloudflare/references/tunnel/configuration.md +157 -0
- package/skills/cloudflare/references/tunnel/gotchas.md +147 -0
- package/skills/cloudflare/references/tunnel/networking.md +168 -0
- package/skills/cloudflare/references/tunnel/patterns.md +192 -0
- package/skills/cloudflare/references/turn/README.md +82 -0
- package/skills/cloudflare/references/turn/api.md +239 -0
- package/skills/cloudflare/references/turn/configuration.md +179 -0
- package/skills/cloudflare/references/turn/gotchas.md +231 -0
- package/skills/cloudflare/references/turn/patterns.md +213 -0
- package/skills/cloudflare/references/turnstile/README.md +99 -0
- package/skills/cloudflare/references/turnstile/api.md +240 -0
- package/skills/cloudflare/references/turnstile/configuration.md +222 -0
- package/skills/cloudflare/references/turnstile/gotchas.md +218 -0
- package/skills/cloudflare/references/turnstile/patterns.md +193 -0
- package/skills/cloudflare/references/vectorize/README.md +133 -0
- package/skills/cloudflare/references/vectorize/api.md +88 -0
- package/skills/cloudflare/references/vectorize/configuration.md +88 -0
- package/skills/cloudflare/references/vectorize/gotchas.md +76 -0
- package/skills/cloudflare/references/vectorize/patterns.md +90 -0
- package/skills/cloudflare/references/waf/README.md +113 -0
- package/skills/cloudflare/references/waf/api.md +202 -0
- package/skills/cloudflare/references/waf/configuration.md +203 -0
- package/skills/cloudflare/references/waf/gotchas.md +204 -0
- package/skills/cloudflare/references/waf/patterns.md +197 -0
- package/skills/cloudflare/references/web-analytics/README.md +141 -0
- package/skills/cloudflare/references/web-analytics/configuration.md +76 -0
- package/skills/cloudflare/references/web-analytics/gotchas.md +82 -0
- package/skills/cloudflare/references/web-analytics/integration.md +60 -0
- package/skills/cloudflare/references/web-analytics/patterns.md +91 -0
- package/skills/cloudflare/references/workerd/README.md +78 -0
- package/skills/cloudflare/references/workerd/api.md +185 -0
- package/skills/cloudflare/references/workerd/configuration.md +183 -0
- package/skills/cloudflare/references/workerd/gotchas.md +139 -0
- package/skills/cloudflare/references/workerd/patterns.md +192 -0
- package/skills/cloudflare/references/workers/README.md +108 -0
- package/skills/cloudflare/references/workers/api.md +195 -0
- package/skills/cloudflare/references/workers/configuration.md +185 -0
- package/skills/cloudflare/references/workers/frameworks.md +197 -0
- package/skills/cloudflare/references/workers/gotchas.md +137 -0
- package/skills/cloudflare/references/workers/patterns.md +198 -0
- package/skills/cloudflare/references/workers-ai/README.md +197 -0
- package/skills/cloudflare/references/workers-ai/api.md +112 -0
- package/skills/cloudflare/references/workers-ai/configuration.md +97 -0
- package/skills/cloudflare/references/workers-ai/gotchas.md +114 -0
- package/skills/cloudflare/references/workers-ai/patterns.md +120 -0
- package/skills/cloudflare/references/workers-for-platforms/README.md +89 -0
- package/skills/cloudflare/references/workers-for-platforms/api.md +196 -0
- package/skills/cloudflare/references/workers-for-platforms/configuration.md +167 -0
- package/skills/cloudflare/references/workers-for-platforms/gotchas.md +134 -0
- package/skills/cloudflare/references/workers-for-platforms/patterns.md +188 -0
- package/skills/cloudflare/references/workers-playground/README.md +127 -0
- package/skills/cloudflare/references/workers-playground/api.md +101 -0
- package/skills/cloudflare/references/workers-playground/configuration.md +163 -0
- package/skills/cloudflare/references/workers-playground/gotchas.md +88 -0
- package/skills/cloudflare/references/workers-playground/patterns.md +132 -0
- package/skills/cloudflare/references/workers-vpc/README.md +127 -0
- package/skills/cloudflare/references/workers-vpc/api.md +202 -0
- package/skills/cloudflare/references/workers-vpc/configuration.md +147 -0
- package/skills/cloudflare/references/workers-vpc/gotchas.md +167 -0
- package/skills/cloudflare/references/workers-vpc/patterns.md +209 -0
- package/skills/cloudflare/references/workflows/README.md +77 -0
- package/skills/cloudflare/references/workflows/api.md +218 -0
- package/skills/cloudflare/references/workflows/configuration.md +152 -0
- package/skills/cloudflare/references/workflows/gotchas.md +90 -0
- package/skills/cloudflare/references/workflows/patterns.md +175 -0
- package/skills/cloudflare/references/wrangler/README.md +135 -0
- package/skills/cloudflare/references/wrangler/api.md +188 -0
- package/skills/cloudflare/references/wrangler/configuration.md +197 -0
- package/skills/cloudflare/references/wrangler/gotchas.md +197 -0
- package/skills/cloudflare/references/wrangler/patterns.md +209 -0
- package/skills/cloudflare/references/zaraz/IMPLEMENTATION_SUMMARY.md +121 -0
- package/skills/cloudflare/references/zaraz/README.md +111 -0
- package/skills/cloudflare/references/zaraz/api.md +112 -0
- package/skills/cloudflare/references/zaraz/configuration.md +90 -0
- package/skills/cloudflare/references/zaraz/gotchas.md +81 -0
- package/skills/cloudflare/references/zaraz/patterns.md +74 -0
- package/skills/cloudflare-email-service/SKILL.md +103 -0
- package/skills/cloudflare-email-service/references/cli-and-mcp.md +125 -0
- package/skills/cloudflare-email-service/references/deliverability.md +285 -0
- package/skills/cloudflare-email-service/references/rest-api.md +184 -0
- package/skills/cloudflare-email-service/references/routing.md +199 -0
- package/skills/cloudflare-email-service/references/sending.md +252 -0
- package/skills/cloudflare-one/SKILL.md +176 -0
- package/skills/cloudflare-one-migrations/SKILL.md +110 -0
- package/skills/durable-objects/SKILL.md +186 -0
- package/skills/durable-objects/references/rules.md +295 -0
- package/skills/durable-objects/references/testing.md +264 -0
- package/skills/durable-objects/references/workers.md +346 -0
- package/skills/sandbox-migrate-to-next/SKILL.md +185 -0
- package/skills/sandbox-next/SKILL.md +91 -0
- package/skills/sandbox-next/references/api-quick-ref.md +94 -0
- package/skills/sandbox-next/references/examples.md +15 -0
- package/skills/sandbox-stable/SKILL.md +110 -0
- package/skills/turnstile-spin/README.md +51 -0
- package/skills/turnstile-spin/SKILL.md +330 -0
- package/skills/turnstile-spin/references/astro.md +199 -0
- package/skills/turnstile-spin/references/hugo.md +114 -0
- package/skills/turnstile-spin/references/nextjs-app.md +261 -0
- package/skills/turnstile-spin/references/nextjs-pages.md +82 -0
- package/skills/turnstile-spin/references/sveltekit.md +191 -0
- package/skills/turnstile-spin/references/vanilla-html.md +157 -0
- package/skills/turnstile-spin/scripts/auth-probe.sh +285 -0
- package/skills/turnstile-spin/scripts/persist-skill.sh +114 -0
- package/skills/turnstile-spin/scripts/validate.sh +137 -0
- package/skills/turnstile-spin/scripts/widget-create.sh +121 -0
- package/skills/turnstile-spin/tests/validation.md +62 -0
- package/skills/workers-best-practices/SKILL.md +127 -0
- package/skills/workers-best-practices/references/review.md +174 -0
- package/skills/workers-best-practices/references/rules.md +467 -0
- package/skills/wrangler/SKILL.md +922 -0
|
@@ -0,0 +1,206 @@
|
|
|
1
|
+
# Queues Gotchas & Troubleshooting
|
|
2
|
+
|
|
3
|
+
## CRITICAL: Top Production Mistakes
|
|
4
|
+
|
|
5
|
+
### 1. "Entire Batch Retried After Single Error"
|
|
6
|
+
|
|
7
|
+
**Problem:** Throwing uncaught error in queue handler retries the entire batch, not just the failed message
|
|
8
|
+
**Cause:** Uncaught exceptions propagate to the runtime, triggering batch-level retry
|
|
9
|
+
**Solution:** Always wrap individual message processing in try/catch and call `msg.retry()` explicitly
|
|
10
|
+
|
|
11
|
+
```typescript
|
|
12
|
+
// ❌ BAD: Throws error, retries entire batch
|
|
13
|
+
async queue(batch: MessageBatch): Promise<void> {
|
|
14
|
+
for (const msg of batch.messages) {
|
|
15
|
+
await riskyOperation(msg.body); // If this throws, entire batch retries
|
|
16
|
+
msg.ack();
|
|
17
|
+
}
|
|
18
|
+
}
|
|
19
|
+
|
|
20
|
+
// ✅ GOOD: Catch per message, handle individually
|
|
21
|
+
async queue(batch: MessageBatch): Promise<void> {
|
|
22
|
+
for (const msg of batch.messages) {
|
|
23
|
+
try {
|
|
24
|
+
await riskyOperation(msg.body);
|
|
25
|
+
msg.ack();
|
|
26
|
+
} catch (error) {
|
|
27
|
+
msg.retry({ delaySeconds: 60 });
|
|
28
|
+
}
|
|
29
|
+
}
|
|
30
|
+
}
|
|
31
|
+
```
|
|
32
|
+
|
|
33
|
+
### 2. "Messages Retry Forever"
|
|
34
|
+
|
|
35
|
+
**Problem:** Messages not explicitly ack'd or retry'd will auto-retry indefinitely
|
|
36
|
+
**Cause:** Runtime default behavior retries unhandled messages until `max_retries` reached
|
|
37
|
+
**Solution:** Always call `msg.ack()` or `msg.retry()` for each message. Never leave messages unhandled.
|
|
38
|
+
|
|
39
|
+
```typescript
|
|
40
|
+
// ❌ BAD: Skipped messages auto-retry forever
|
|
41
|
+
async queue(batch: MessageBatch): Promise<void> {
|
|
42
|
+
for (const msg of batch.messages) {
|
|
43
|
+
if (shouldProcess(msg.body)) {
|
|
44
|
+
await process(msg.body);
|
|
45
|
+
msg.ack();
|
|
46
|
+
}
|
|
47
|
+
// Missing: msg.ack() for skipped messages - they will retry!
|
|
48
|
+
}
|
|
49
|
+
}
|
|
50
|
+
|
|
51
|
+
// ✅ GOOD: Explicitly handle all messages
|
|
52
|
+
async queue(batch: MessageBatch): Promise<void> {
|
|
53
|
+
for (const msg of batch.messages) {
|
|
54
|
+
if (shouldProcess(msg.body)) {
|
|
55
|
+
await process(msg.body);
|
|
56
|
+
msg.ack();
|
|
57
|
+
} else {
|
|
58
|
+
msg.ack(); // Explicitly ack even if not processing
|
|
59
|
+
}
|
|
60
|
+
}
|
|
61
|
+
}
|
|
62
|
+
```
|
|
63
|
+
|
|
64
|
+
## Common Errors
|
|
65
|
+
|
|
66
|
+
### "Duplicate Message Processing"
|
|
67
|
+
|
|
68
|
+
**Problem:** Same message processed multiple times
|
|
69
|
+
**Cause:** At-least-once delivery guarantee means duplicates are possible during retries
|
|
70
|
+
**Solution:** Design consumers to be idempotent by tracking processed message IDs in KV with expiration TTL
|
|
71
|
+
|
|
72
|
+
```typescript
|
|
73
|
+
async queue(batch: MessageBatch, env: Env): Promise<void> {
|
|
74
|
+
for (const msg of batch.messages) {
|
|
75
|
+
const processed = await env.PROCESSED_KV.get(msg.id);
|
|
76
|
+
if (processed) {
|
|
77
|
+
msg.ack();
|
|
78
|
+
continue;
|
|
79
|
+
}
|
|
80
|
+
|
|
81
|
+
await processMessage(msg.body);
|
|
82
|
+
await env.PROCESSED_KV.put(msg.id, '1', { expirationTtl: 86400 });
|
|
83
|
+
msg.ack();
|
|
84
|
+
}
|
|
85
|
+
}
|
|
86
|
+
```
|
|
87
|
+
|
|
88
|
+
### "Pull Consumer Can't Decode Messages"
|
|
89
|
+
|
|
90
|
+
**Problem:** Pull consumer or dashboard shows unreadable message bodies
|
|
91
|
+
**Cause:** Messages sent with `v8` content type are only decodable by Workers push consumers
|
|
92
|
+
**Solution:** Use `json` content type for pull consumers or dashboard visibility
|
|
93
|
+
|
|
94
|
+
```typescript
|
|
95
|
+
// Use json for pull consumers
|
|
96
|
+
await env.MY_QUEUE.send(data, { contentType: 'json' });
|
|
97
|
+
|
|
98
|
+
// Use v8 only for push consumers with complex JS types
|
|
99
|
+
await env.MY_QUEUE.send({ date: new Date(), tags: new Set() }, { contentType: 'v8' });
|
|
100
|
+
```
|
|
101
|
+
|
|
102
|
+
### "Messages Not Being Delivered"
|
|
103
|
+
|
|
104
|
+
**Problem:** Messages sent but consumer not processing
|
|
105
|
+
**Cause:** Queue paused, consumer not configured, or consumer errors
|
|
106
|
+
**Solution:** Check queue status with `wrangler queues list`, verify consumer configured with `wrangler queues consumer add`, and check logs with `wrangler tail`
|
|
107
|
+
|
|
108
|
+
### "High Dead Letter Queue Rate"
|
|
109
|
+
|
|
110
|
+
**Problem:** Many messages ending up in DLQ
|
|
111
|
+
**Cause:** Consumer repeatedly failing to process messages after max retries
|
|
112
|
+
**Solution:** Review consumer error logs, check external dependency availability, verify message format matches expectations, or increase retry delay
|
|
113
|
+
|
|
114
|
+
## Error Classification Patterns
|
|
115
|
+
|
|
116
|
+
Classify errors to decide whether to retry or DLQ:
|
|
117
|
+
|
|
118
|
+
```typescript
|
|
119
|
+
async queue(batch: MessageBatch, env: Env): Promise<void> {
|
|
120
|
+
for (const msg of batch.messages) {
|
|
121
|
+
try {
|
|
122
|
+
await processMessage(msg.body);
|
|
123
|
+
msg.ack();
|
|
124
|
+
} catch (error) {
|
|
125
|
+
// Transient errors: retry with backoff
|
|
126
|
+
if (isRetryable(error)) {
|
|
127
|
+
const delay = Math.min(30 * (2 ** msg.attempts), 43200);
|
|
128
|
+
msg.retry({ delaySeconds: delay });
|
|
129
|
+
}
|
|
130
|
+
// Permanent errors: ack to avoid infinite retries
|
|
131
|
+
else {
|
|
132
|
+
console.error('Permanent error, sending to DLQ:', error);
|
|
133
|
+
await env.ERROR_LOG.put(msg.id, JSON.stringify({ msg: msg.body, error: String(error) }));
|
|
134
|
+
msg.ack(); // Prevent further retries
|
|
135
|
+
}
|
|
136
|
+
}
|
|
137
|
+
}
|
|
138
|
+
}
|
|
139
|
+
|
|
140
|
+
function isRetryable(error: unknown): boolean {
|
|
141
|
+
if (error instanceof Response) {
|
|
142
|
+
// Retry: rate limits, timeouts, server errors
|
|
143
|
+
return error.status === 429 || error.status >= 500;
|
|
144
|
+
}
|
|
145
|
+
if (error instanceof Error) {
|
|
146
|
+
// Don't retry: validation, auth, not found
|
|
147
|
+
return !error.message.includes('validation') &&
|
|
148
|
+
!error.message.includes('unauthorized') &&
|
|
149
|
+
!error.message.includes('not found');
|
|
150
|
+
}
|
|
151
|
+
return false; // Unknown errors don't retry
|
|
152
|
+
}
|
|
153
|
+
```
|
|
154
|
+
|
|
155
|
+
### "CPU Time Exceeded in Consumer"
|
|
156
|
+
|
|
157
|
+
**Problem:** Consumer fails with CPU time limit exceeded
|
|
158
|
+
**Cause:** Consumer processing exceeding 30s default CPU time limit
|
|
159
|
+
**Solution:** Increase CPU limit in wrangler.jsonc: `{ "limits": { "cpu_ms": 300000 } }` (5 minutes max)
|
|
160
|
+
|
|
161
|
+
## Content Type Decision Guide
|
|
162
|
+
|
|
163
|
+
**When to use each content type:**
|
|
164
|
+
|
|
165
|
+
| Content Type | Use When | Readable By | Supports |
|
|
166
|
+
|--------------|----------|-------------|----------|
|
|
167
|
+
| `json` (default) | Pull consumers, dashboard visibility, simple objects | All (push/pull/dashboard) | JSON-serializable types only |
|
|
168
|
+
| `v8` | Push consumers only, complex JS objects | Push consumers only | Date, Map, Set, BigInt, typed arrays |
|
|
169
|
+
| `text` | String-only payloads | All | Strings only |
|
|
170
|
+
| `bytes` | Binary data (images, files) | All | ArrayBuffer, Uint8Array |
|
|
171
|
+
|
|
172
|
+
**Decision tree:**
|
|
173
|
+
1. Need to view in dashboard or use pull consumer? → Use `json`
|
|
174
|
+
2. Need Date, Map, Set, or other V8 types? → Use `v8` (push consumers only)
|
|
175
|
+
3. Just strings? → Use `text`
|
|
176
|
+
4. Binary data? → Use `bytes`
|
|
177
|
+
|
|
178
|
+
```typescript
|
|
179
|
+
// Dashboard/pull: use json
|
|
180
|
+
await env.QUEUE.send({ id: 123, name: 'test' }, { contentType: 'json' });
|
|
181
|
+
|
|
182
|
+
// Complex JS types (push only): use v8
|
|
183
|
+
await env.QUEUE.send({
|
|
184
|
+
created: new Date(),
|
|
185
|
+
tags: new Set(['a', 'b'])
|
|
186
|
+
}, { contentType: 'v8' });
|
|
187
|
+
```
|
|
188
|
+
|
|
189
|
+
## Limits
|
|
190
|
+
|
|
191
|
+
| Limit | Value | Notes |
|
|
192
|
+
|-------|-------|-------|
|
|
193
|
+
| Max queues | 10,000 | Per account |
|
|
194
|
+
| Message size | 128 KB | Maximum per message |
|
|
195
|
+
| Batch size (consumer) | 100 messages | Maximum messages per batch |
|
|
196
|
+
| Batch size (sendBatch) | 100 msgs or 256 KB | Whichever limit reached first |
|
|
197
|
+
| Throughput | 5,000 msgs/sec | Per queue |
|
|
198
|
+
| Retention | 4-14 days | Configurable retention period |
|
|
199
|
+
| Max backlog | 25 GB | Maximum queue backlog size |
|
|
200
|
+
| Max delay | 12 hours (43,200s) | Maximum message delay |
|
|
201
|
+
| Max retries | 100 | Maximum retry attempts |
|
|
202
|
+
| CPU time default | 30s | Per consumer invocation |
|
|
203
|
+
| CPU time max | 300s (5 min) | Configurable via `limits.cpu_ms` |
|
|
204
|
+
| Operations per message | 3 (write + read + delete) | Base cost per message |
|
|
205
|
+
| Pricing | $0.40 per 1M operations | After 1M free operations |
|
|
206
|
+
| Message charging | Per 64 KB chunk | Messages charged in 64 KB increments |
|
|
@@ -0,0 +1,220 @@
|
|
|
1
|
+
# Queues Patterns & Best Practices
|
|
2
|
+
|
|
3
|
+
## Async Task Processing
|
|
4
|
+
|
|
5
|
+
```typescript
|
|
6
|
+
// Producer: Accept request, queue work
|
|
7
|
+
export default {
|
|
8
|
+
async fetch(request: Request, env: Env): Promise<Response> {
|
|
9
|
+
const { userId, reportType } = await request.json();
|
|
10
|
+
await env.REPORT_QUEUE.send({ userId, reportType, requestedAt: Date.now() });
|
|
11
|
+
return Response.json({ message: 'Report queued', status: 'pending' });
|
|
12
|
+
}
|
|
13
|
+
};
|
|
14
|
+
|
|
15
|
+
// Consumer: Process reports
|
|
16
|
+
export default {
|
|
17
|
+
async queue(batch: MessageBatch, env: Env): Promise<void> {
|
|
18
|
+
for (const msg of batch.messages) {
|
|
19
|
+
const { userId, reportType } = msg.body;
|
|
20
|
+
const report = await generateReport(userId, reportType, env);
|
|
21
|
+
await env.REPORTS_BUCKET.put(`${userId}/${reportType}.pdf`, report);
|
|
22
|
+
msg.ack();
|
|
23
|
+
}
|
|
24
|
+
}
|
|
25
|
+
};
|
|
26
|
+
```
|
|
27
|
+
|
|
28
|
+
## Buffering API Calls
|
|
29
|
+
|
|
30
|
+
```typescript
|
|
31
|
+
// Producer: Queue log entries
|
|
32
|
+
ctx.waitUntil(env.LOGS_QUEUE.send({
|
|
33
|
+
method: request.method,
|
|
34
|
+
url: request.url,
|
|
35
|
+
timestamp: Date.now()
|
|
36
|
+
}));
|
|
37
|
+
|
|
38
|
+
// Consumer: Batch write to external API
|
|
39
|
+
async queue(batch: MessageBatch, env: Env): Promise<void> {
|
|
40
|
+
const logs = batch.messages.map(m => m.body);
|
|
41
|
+
await fetch(env.LOG_ENDPOINT, { method: 'POST', body: JSON.stringify({ logs }) });
|
|
42
|
+
batch.ackAll();
|
|
43
|
+
}
|
|
44
|
+
```
|
|
45
|
+
|
|
46
|
+
## Rate Limiting Upstream
|
|
47
|
+
|
|
48
|
+
```typescript
|
|
49
|
+
async queue(batch: MessageBatch, env: Env): Promise<void> {
|
|
50
|
+
for (const msg of batch.messages) {
|
|
51
|
+
try {
|
|
52
|
+
await callRateLimitedAPI(msg.body);
|
|
53
|
+
msg.ack();
|
|
54
|
+
} catch (error) {
|
|
55
|
+
if (error.status === 429) {
|
|
56
|
+
const retryAfter = parseInt(error.headers.get('Retry-After') || '60');
|
|
57
|
+
msg.retry({ delaySeconds: retryAfter });
|
|
58
|
+
} else throw error;
|
|
59
|
+
}
|
|
60
|
+
}
|
|
61
|
+
}
|
|
62
|
+
```
|
|
63
|
+
|
|
64
|
+
## Event-Driven Workflows
|
|
65
|
+
|
|
66
|
+
```typescript
|
|
67
|
+
// R2 event → Queue → Worker
|
|
68
|
+
export default {
|
|
69
|
+
async queue(batch: MessageBatch, env: Env): Promise<void> {
|
|
70
|
+
for (const msg of batch.messages) {
|
|
71
|
+
const event = msg.body;
|
|
72
|
+
if (event.action === 'PutObject') {
|
|
73
|
+
await processNewFile(event.object.key, env);
|
|
74
|
+
} else if (event.action === 'DeleteObject') {
|
|
75
|
+
await cleanupReferences(event.object.key, env);
|
|
76
|
+
}
|
|
77
|
+
msg.ack();
|
|
78
|
+
}
|
|
79
|
+
}
|
|
80
|
+
};
|
|
81
|
+
```
|
|
82
|
+
|
|
83
|
+
## Dead Letter Queue Pattern
|
|
84
|
+
|
|
85
|
+
```typescript
|
|
86
|
+
// Main queue: After max_retries, goes to DLQ automatically
|
|
87
|
+
export default {
|
|
88
|
+
async queue(batch: MessageBatch, env: Env): Promise<void> {
|
|
89
|
+
for (const msg of batch.messages) {
|
|
90
|
+
try {
|
|
91
|
+
await riskyOperation(msg.body);
|
|
92
|
+
msg.ack();
|
|
93
|
+
} catch (error) {
|
|
94
|
+
console.error(`Failed after ${msg.attempts} attempts:`, error);
|
|
95
|
+
}
|
|
96
|
+
}
|
|
97
|
+
}
|
|
98
|
+
};
|
|
99
|
+
|
|
100
|
+
// DLQ consumer: Log and store failed messages
|
|
101
|
+
export default {
|
|
102
|
+
async queue(batch: MessageBatch, env: Env): Promise<void> {
|
|
103
|
+
for (const msg of batch.messages) {
|
|
104
|
+
await env.FAILED_KV.put(msg.id, JSON.stringify(msg.body));
|
|
105
|
+
msg.ack();
|
|
106
|
+
}
|
|
107
|
+
}
|
|
108
|
+
};
|
|
109
|
+
```
|
|
110
|
+
|
|
111
|
+
## Priority Queues
|
|
112
|
+
|
|
113
|
+
High priority: `max_batch_size: 5, max_batch_timeout: 1`. Low priority: `max_batch_size: 100, max_batch_timeout: 30`.
|
|
114
|
+
|
|
115
|
+
## Delayed Job Processing
|
|
116
|
+
|
|
117
|
+
```typescript
|
|
118
|
+
await env.EMAIL_QUEUE.send({ to, template, userId }, { delaySeconds: 3600 });
|
|
119
|
+
```
|
|
120
|
+
|
|
121
|
+
## Fan-out Pattern
|
|
122
|
+
|
|
123
|
+
```typescript
|
|
124
|
+
async fetch(request: Request, env: Env): Promise<Response> {
|
|
125
|
+
const event = await request.json();
|
|
126
|
+
|
|
127
|
+
// Send to multiple queues for parallel processing
|
|
128
|
+
await Promise.all([
|
|
129
|
+
env.ANALYTICS_QUEUE.send(event),
|
|
130
|
+
env.NOTIFICATIONS_QUEUE.send(event),
|
|
131
|
+
env.AUDIT_LOG_QUEUE.send(event)
|
|
132
|
+
]);
|
|
133
|
+
|
|
134
|
+
return Response.json({ status: 'processed' });
|
|
135
|
+
}
|
|
136
|
+
```
|
|
137
|
+
|
|
138
|
+
## Idempotency Pattern
|
|
139
|
+
|
|
140
|
+
```typescript
|
|
141
|
+
async queue(batch: MessageBatch, env: Env): Promise<void> {
|
|
142
|
+
for (const msg of batch.messages) {
|
|
143
|
+
// Check if already processed
|
|
144
|
+
const processed = await env.PROCESSED_KV.get(msg.id);
|
|
145
|
+
if (processed) {
|
|
146
|
+
msg.ack();
|
|
147
|
+
continue;
|
|
148
|
+
}
|
|
149
|
+
|
|
150
|
+
await processMessage(msg.body);
|
|
151
|
+
await env.PROCESSED_KV.put(msg.id, '1', { expirationTtl: 86400 });
|
|
152
|
+
msg.ack();
|
|
153
|
+
}
|
|
154
|
+
}
|
|
155
|
+
```
|
|
156
|
+
|
|
157
|
+
## Integration: D1 Batch Writes
|
|
158
|
+
|
|
159
|
+
```typescript
|
|
160
|
+
async queue(batch: MessageBatch, env: Env): Promise<void> {
|
|
161
|
+
// Collect all inserts for single D1 batch
|
|
162
|
+
const statements = batch.messages.map(msg =>
|
|
163
|
+
env.DB.prepare('INSERT INTO events (id, data, created) VALUES (?, ?, ?)')
|
|
164
|
+
.bind(msg.id, JSON.stringify(msg.body), Date.now())
|
|
165
|
+
);
|
|
166
|
+
|
|
167
|
+
try {
|
|
168
|
+
await env.DB.batch(statements);
|
|
169
|
+
batch.ackAll();
|
|
170
|
+
} catch (error) {
|
|
171
|
+
console.error('D1 batch failed:', error);
|
|
172
|
+
batch.retryAll({ delaySeconds: 60 });
|
|
173
|
+
}
|
|
174
|
+
}
|
|
175
|
+
```
|
|
176
|
+
|
|
177
|
+
## Integration: Workflows
|
|
178
|
+
|
|
179
|
+
```typescript
|
|
180
|
+
// Queue triggers Workflow for long-running tasks
|
|
181
|
+
async queue(batch: MessageBatch, env: Env): Promise<void> {
|
|
182
|
+
for (const msg of batch.messages) {
|
|
183
|
+
try {
|
|
184
|
+
const instance = await env.MY_WORKFLOW.create({
|
|
185
|
+
id: msg.id,
|
|
186
|
+
params: msg.body
|
|
187
|
+
});
|
|
188
|
+
console.log('Workflow started:', instance.id);
|
|
189
|
+
msg.ack();
|
|
190
|
+
} catch (error) {
|
|
191
|
+
msg.retry({ delaySeconds: 30 });
|
|
192
|
+
}
|
|
193
|
+
}
|
|
194
|
+
}
|
|
195
|
+
```
|
|
196
|
+
|
|
197
|
+
## Integration: Durable Objects
|
|
198
|
+
|
|
199
|
+
```typescript
|
|
200
|
+
// Queue distributes work to Durable Objects by ID
|
|
201
|
+
async queue(batch: MessageBatch, env: Env): Promise<void> {
|
|
202
|
+
for (const msg of batch.messages) {
|
|
203
|
+
const { userId, action } = msg.body;
|
|
204
|
+
|
|
205
|
+
// Route to user-specific DO
|
|
206
|
+
const id = env.USER_DO.idFromName(userId);
|
|
207
|
+
const stub = env.USER_DO.get(id);
|
|
208
|
+
|
|
209
|
+
try {
|
|
210
|
+
await stub.fetch(new Request('https://do/process', {
|
|
211
|
+
method: 'POST',
|
|
212
|
+
body: JSON.stringify({ action, messageId: msg.id })
|
|
213
|
+
}));
|
|
214
|
+
msg.ack();
|
|
215
|
+
} catch (error) {
|
|
216
|
+
msg.retry({ delaySeconds: 60 });
|
|
217
|
+
}
|
|
218
|
+
}
|
|
219
|
+
}
|
|
220
|
+
```
|
|
@@ -0,0 +1,95 @@
|
|
|
1
|
+
# Cloudflare R2 Object Storage
|
|
2
|
+
|
|
3
|
+
S3-compatible object storage with zero egress fees, optimized for large file storage and delivery.
|
|
4
|
+
|
|
5
|
+
## Overview
|
|
6
|
+
|
|
7
|
+
R2 provides:
|
|
8
|
+
- S3-compatible API (Workers API + S3 REST)
|
|
9
|
+
- Zero egress fees globally
|
|
10
|
+
- Strong consistency for writes/deletes
|
|
11
|
+
- Storage classes (Standard/Infrequent Access)
|
|
12
|
+
- SSE-C encryption support
|
|
13
|
+
|
|
14
|
+
**Use cases:** Media storage, backups, static assets, user uploads, data lakes
|
|
15
|
+
|
|
16
|
+
## Quick Start
|
|
17
|
+
|
|
18
|
+
```bash
|
|
19
|
+
wrangler r2 bucket create my-bucket --location=enam
|
|
20
|
+
wrangler r2 object put my-bucket/file.txt --file=./local.txt
|
|
21
|
+
```
|
|
22
|
+
|
|
23
|
+
```typescript
|
|
24
|
+
// Upload
|
|
25
|
+
await env.MY_BUCKET.put(key, data, {
|
|
26
|
+
httpMetadata: { contentType: 'image/jpeg' }
|
|
27
|
+
});
|
|
28
|
+
|
|
29
|
+
// Download
|
|
30
|
+
const object = await env.MY_BUCKET.get(key);
|
|
31
|
+
if (object) return new Response(object.body);
|
|
32
|
+
```
|
|
33
|
+
|
|
34
|
+
## Core Operations
|
|
35
|
+
|
|
36
|
+
| Method | Purpose | Returns |
|
|
37
|
+
|--------|---------|---------|
|
|
38
|
+
| `put(key, value, options?)` | Upload object | `R2Object \| null` |
|
|
39
|
+
| `get(key, options?)` | Download object | `R2ObjectBody \| R2Object \| null` |
|
|
40
|
+
| `head(key)` | Get metadata only | `R2Object \| null` |
|
|
41
|
+
| `delete(keys)` | Delete object(s) | `Promise<void>` |
|
|
42
|
+
| `list(options?)` | List objects | `R2Objects` |
|
|
43
|
+
|
|
44
|
+
## Storage Classes
|
|
45
|
+
|
|
46
|
+
- **Standard**: Frequent access, low latency reads
|
|
47
|
+
- **InfrequentAccess**: 30-day minimum storage, retrieval fees, lower storage cost
|
|
48
|
+
|
|
49
|
+
## Event Notifications
|
|
50
|
+
|
|
51
|
+
R2 integrates with Cloudflare Queues for reactive workflows:
|
|
52
|
+
|
|
53
|
+
```typescript
|
|
54
|
+
// wrangler.jsonc
|
|
55
|
+
{
|
|
56
|
+
"event_notifications": [{
|
|
57
|
+
"queue": "r2-notifications",
|
|
58
|
+
"actions": ["PutObject", "DeleteObject"]
|
|
59
|
+
}]
|
|
60
|
+
}
|
|
61
|
+
|
|
62
|
+
// Consumer
|
|
63
|
+
async queue(batch: MessageBatch, env: Env) {
|
|
64
|
+
for (const message of batch.messages) {
|
|
65
|
+
const event = message.body; // { action, bucket, object, timestamps }
|
|
66
|
+
if (event.action === 'PutObject') {
|
|
67
|
+
// Process upload: thumbnail generation, virus scan, etc.
|
|
68
|
+
}
|
|
69
|
+
}
|
|
70
|
+
}
|
|
71
|
+
```
|
|
72
|
+
|
|
73
|
+
## Reading Order
|
|
74
|
+
|
|
75
|
+
**First-time users:** README → configuration.md → api.md → patterns.md
|
|
76
|
+
**Specific tasks:**
|
|
77
|
+
- Setup: configuration.md
|
|
78
|
+
- Client uploads: patterns.md (presigned URLs)
|
|
79
|
+
- Public static site: patterns.md (public access + custom domain)
|
|
80
|
+
- Processing uploads: README (event notifications) + queues reference
|
|
81
|
+
- Debugging: gotchas.md
|
|
82
|
+
|
|
83
|
+
## In This Reference
|
|
84
|
+
|
|
85
|
+
- [configuration.md](./configuration.md) - Bindings, S3 SDK, CORS, lifecycles, token scopes
|
|
86
|
+
- [api.md](./api.md) - Workers API, multipart, conditional requests, presigned URLs
|
|
87
|
+
- [patterns.md](./patterns.md) - Streaming, caching, client uploads, public buckets
|
|
88
|
+
- [gotchas.md](./gotchas.md) - List truncation, etag format, stream length, S3 SDK region
|
|
89
|
+
|
|
90
|
+
## See Also
|
|
91
|
+
|
|
92
|
+
- [workers](../workers/) - Worker runtime and fetch handlers
|
|
93
|
+
- [kv](../kv/) - Metadata storage for R2 objects
|
|
94
|
+
- [d1](../d1/) - Store R2 URLs in relational database
|
|
95
|
+
- [queues](../queues/) - Process R2 uploads asynchronously
|