Skip to content

Conversation

@joshthoward
Copy link
Contributor

Summary

Document new method getByName() for getting Durable Object stubs and update references to idFromName() where ID is not used directly.

  • Is there a changelog entry (guidelines)? If you don't add one for something awesome and new (however small) — how will our customers find out? Changelogs are automatically posted to RSS feeds, the Discord, and X.
  • The documentation style guide has been adhered to.
  • If a larger change - such as adding a new page- an issue has been opened in relation to any incorrect or out of date information that this PR fixes.
  • Files which have changed name or location have been allocated redirects.

@github-actions
Copy link
Contributor

This PR requires additional review attention because it affects the following areas:

Partials

This PR updates partial files, which are pieces of content used across multiple files in our Render component.

@github-actions github-actions bot added product:browser-rendering product:containers product:durable-objects Durable Objects: https://developers.cloudflare.com/workers/learning/using-durable-objects/ product:queues Cloudflare Queues: https://developers.cloudflare.com/queues product:workers Related to Workers product product:workers-ai Workers AI: https://developers.cloudflare.com/workers-ai/ labels Aug 21, 2025
@github-actions
Copy link
Contributor

This pull request requires reviews from CODEOWNERS as it changes files that match the following patterns:

Pattern Owners
/src/content/docs/browser-rendering/ @mchenco, @cloudflare/pcx-technical-writing, @celso, @danielgek, @kathayl, @ToriLindsay
/src/content/docs/containers/ @mikenomitch, @th0m, @cloudflare/pcx-technical-writing, @cloudflare/cloudchamber
/src/content/docs/durable-objects/ @elithrar, @vy-ton, @joshthoward, @oxyjun, @harshil1712, @mikenomitch, @cloudflare/pcx-technical-writing, @cloudflare/workers-runtime-1
/src/content/docs/queues/ @elithrar, @jonesphillip, @harshil1712, @cloudflare/pcx-technical-writing
/src/content/docs/workers-ai/ @rita3ko, @craigsdennis, @markdembo, @mchenco, @kodster28, @cloudflare/pcx-technical-writing
/src/content/docs/workers/ @cloudflare/workers-docs, @GregBrimble, @irvinebroque, @mikenomitch, @korinne, @WalshyDev, @cloudflare/deploy-config, @cloudflare/pcx-technical-writing, @kodster28, @cloudflare/wrangler, @cloudflare/workers-runtime-1, @cloudflare/wrangler
* @cloudflare/pcx-technical-writing

@github-actions
Copy link
Contributor

Preview URL: https://06c9c9c9.preview.developers.cloudflare.com
Preview Branch URL: https://jhoward-getbyname.preview.developers.cloudflare.com

Files with changes (up to 15)

Original Link Updated Link
https://developers.cloudflare.com/workers/tutorials/live-cursors-with-nextjs-rpc-do/ https://jhoward-getbyname.preview.developers.cloudflare.com/workers/tutorials/live-cursors-with-nextjs-rpc-do/
https://developers.cloudflare.com/durable-objects/examples/use-kv-from-durable-objects/ https://jhoward-getbyname.preview.developers.cloudflare.com/durable-objects/examples/use-kv-from-durable-objects/
https://developers.cloudflare.com/durable-objects/get-started/ https://jhoward-getbyname.preview.developers.cloudflare.com/durable-objects/get-started/
https://developers.cloudflare.com/durable-objects/api/namespace/ https://jhoward-getbyname.preview.developers.cloudflare.com/durable-objects/api/namespace/
https://developers.cloudflare.com/durable-objects/api/alarms/ https://jhoward-getbyname.preview.developers.cloudflare.com/durable-objects/api/alarms/
https://developers.cloudflare.com/durable-objects/examples/readable-stream/ https://jhoward-getbyname.preview.developers.cloudflare.com/durable-objects/examples/readable-stream/
https://developers.cloudflare.com/durable-objects/best-practices/create-durable-object-stubs-and-send-requests/ https://jhoward-getbyname.preview.developers.cloudflare.com/durable-objects/best-practices/create-durable-object-stubs-and-send-requests/
https://developers.cloudflare.com/durable-objects/examples/build-a-counter/ https://jhoward-getbyname.preview.developers.cloudflare.com/durable-objects/examples/build-a-counter/
https://developers.cloudflare.com/durable-objects/best-practices/websockets/ https://jhoward-getbyname.preview.developers.cloudflare.com/durable-objects/best-practices/websockets/
https://developers.cloudflare.com/durable-objects/examples/build-a-rate-limiter/ https://jhoward-getbyname.preview.developers.cloudflare.com/durable-objects/examples/build-a-rate-limiter/
https://developers.cloudflare.com/containers/examples/env-vars-and-secrets/ https://jhoward-getbyname.preview.developers.cloudflare.com/containers/examples/env-vars-and-secrets/
https://developers.cloudflare.com/containers/get-started/ https://jhoward-getbyname.preview.developers.cloudflare.com/containers/get-started/
https://developers.cloudflare.com/durable-objects/examples/durable-object-ttl/ https://jhoward-getbyname.preview.developers.cloudflare.com/durable-objects/examples/durable-object-ttl/
https://developers.cloudflare.com/durable-objects/examples/durable-object-in-memory-state/ https://jhoward-getbyname.preview.developers.cloudflare.com/durable-objects/examples/durable-object-in-memory-state/
https://developers.cloudflare.com/queues/examples/use-queues-with-durable-objects/ https://jhoward-getbyname.preview.developers.cloudflare.com/queues/examples/use-queues-with-durable-objects/

@Oxyjun Oxyjun marked this pull request as draft August 21, 2025 10:21
@Oxyjun Oxyjun marked this pull request as ready for review August 21, 2025 10:21
@Oxyjun Oxyjun merged commit b4d58dd into production Aug 21, 2025
8 checks passed
@Oxyjun Oxyjun deleted the jhoward/getByName branch August 21, 2025 12:34
maxvp pushed a commit that referenced this pull request Aug 24, 2025
…24586)

* Document prefered method getByName for creating Durable Object stubs

* Apply suggestions from code review

* Fixing chapter

* Removing redundant line

* Fixing compilation error

---------

Co-authored-by: Jun Lee <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

product:browser-rendering product:containers product:durable-objects Durable Objects: https://developers.cloudflare.com/workers/learning/using-durable-objects/ product:queues Cloudflare Queues: https://developers.cloudflare.com/queues product:workers Related to Workers product product:workers-ai Workers AI: https://developers.cloudflare.com/workers-ai/ size/xl

Projects

None yet

Development

Successfully merging this pull request may close these issues.