Skip to content

Conversation

@joshthoward
Copy link
Contributor

@joshthoward joshthoward commented Oct 10, 2024

Summary

Add reference documentation for DurableObjectState. A lot of this is taken from the existing WebSockets documentation. I will shortly refactor those docs to operate more like a guide for using WebSockets with and without hibernation.

Screenshots (optional)

Note that the RHS bar needs some fixes to the CSS. Text is being wrapped when it shouldn't be.

Screenshot 2024-10-10 at 12 30 18 PM

Documentation checklist

  • 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.

@joshthoward joshthoward requested review from a team, elithrar and vy-ton as code owners October 10, 2024 17:33
Copy link
Contributor

@hyperlint-ai hyperlint-ai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

4 files reviewed, 8 total issue(s) found.

@github-actions github-actions bot added the product:durable-objects Durable Objects: https://developers.cloudflare.com/workers/learning/using-durable-objects/ label Oct 10, 2024
@MellowYarker
Copy link
Contributor

Looks like the page preview failed to build? https://github.com/cloudflare/cloudflare-docs/actions/runs/11279062020/job/31368913837?pr=17471

Oxyjun and others added 2 commits October 11, 2024 10:11
Co-authored-by: hyperlint-ai[bot] <154288675+hyperlint-ai[bot]@users.noreply.github.com>
Co-authored-by: Lambros Petrou <[email protected]>
@cloudflare-workers-and-pages
Copy link

cloudflare-workers-and-pages bot commented Oct 11, 2024

Deploying cloudflare-docs with  Cloudflare Pages  Cloudflare Pages

Latest commit: fe4bb11
Status: ✅  Deploy successful!
Preview URL: https://99da5e43.cloudflare-docs-7ou.pages.dev
Branch Preview URL: https://joshthoward-do-state.cloudflare-docs-7ou.pages.dev

View logs

@github-actions
Copy link
Contributor

github-actions bot commented Oct 11, 2024

Files with changes (up to 15)

Original Link Updated Link
https://developers.cloudflare.com/durable-objects/api/state/ https://joshthoward-do-state.cloudflare-docs-7ou.pages.dev/durable-objects/api/state/
https://developers.cloudflare.com/durable-objects/reference/in-memory-state/ https://joshthoward-do-state.cloudflare-docs-7ou.pages.dev/durable-objects/reference/in-memory-state/
https://developers.cloudflare.com/durable-objects/api/websockets/ https://joshthoward-do-state.cloudflare-docs-7ou.pages.dev/durable-objects/api/websockets/
https://developers.cloudflare.com/durable-objects/api/namespace/ https://joshthoward-do-state.cloudflare-docs-7ou.pages.dev/durable-objects/api/namespace/
https://developers.cloudflare.com/durable-objects/best-practices/create-durable-object-stubs-and-send-requests/ https://joshthoward-do-state.cloudflare-docs-7ou.pages.dev/durable-objects/best-practices/create-durable-object-stubs-and-send-requests/
https://developers.cloudflare.com/durable-objects/examples/websocket-hibernation-server/ https://joshthoward-do-state.cloudflare-docs-7ou.pages.dev/durable-objects/examples/websocket-hibernation-server/
https://developers.cloudflare.com/durable-objects/get-started/walkthrough/ https://joshthoward-do-state.cloudflare-docs-7ou.pages.dev/durable-objects/get-started/walkthrough/
https://developers.cloudflare.com/durable-objects/api/id/ https://joshthoward-do-state.cloudflare-docs-7ou.pages.dev/durable-objects/api/id/
https://developers.cloudflare.com/durable-objects/api/stub/ https://joshthoward-do-state.cloudflare-docs-7ou.pages.dev/durable-objects/api/stub/
https://developers.cloudflare.com/durable-objects/examples/websocket-server/ https://joshthoward-do-state.cloudflare-docs-7ou.pages.dev/durable-objects/examples/websocket-server/
https://developers.cloudflare.com/durable-objects/reference/data-location/ https://joshthoward-do-state.cloudflare-docs-7ou.pages.dev/durable-objects/reference/data-location/
https://developers.cloudflare.com/workers/testing/vitest-integration/test-apis/ https://joshthoward-do-state.cloudflare-docs-7ou.pages.dev/workers/testing/vitest-integration/test-apis/
https://developers.cloudflare.com/durable-objects/api/alarms/ https://joshthoward-do-state.cloudflare-docs-7ou.pages.dev/durable-objects/api/alarms/
https://developers.cloudflare.com/durable-objects/api/storage-api/ https://joshthoward-do-state.cloudflare-docs-7ou.pages.dev/durable-objects/api/storage-api/
https://developers.cloudflare.com/durable-objects/examples/build-a-rate-limiter/ https://joshthoward-do-state.cloudflare-docs-7ou.pages.dev/durable-objects/examples/build-a-rate-limiter/

@github-actions github-actions bot added size/l product:workers Related to Workers product and removed size/m labels Oct 11, 2024
@github-actions github-actions bot added size/m and removed size/l labels Oct 11, 2024
@Oxyjun Oxyjun self-assigned this Oct 11, 2024
@joshthoward joshthoward enabled auto-merge (squash) October 11, 2024 15:55
@joshthoward joshthoward merged commit 81963e9 into production Oct 11, 2024
13 checks passed
@joshthoward joshthoward deleted the joshthoward/do-state branch October 11, 2024 16:08
elithrar pushed a commit that referenced this pull request Oct 15, 2024
* Add reference documentation for DurableObjectState

* Apply suggestions from code review

Co-authored-by: hyperlint-ai[bot] <154288675+hyperlint-ai[bot]@users.noreply.github.com>
Co-authored-by: Lambros Petrou <[email protected]>

* PCX review. Adding glossary term for "event context", definition TBC.

* Adding missing / from some links.

* Adding in proper definition for "event context" in the glossary.

* Cleaning up "Durable Object instance" to "Durable Object", to align with glossary definition.

* Fixing broken method formatting.

* Temporarily reverting files to avoid merge conflict.

* Durable Object instance -> Durable Object

* Adding link in glossary to pricing page.

---------

Co-authored-by: Jun Lee <[email protected]>
Co-authored-by: hyperlint-ai[bot] <154288675+hyperlint-ai[bot]@users.noreply.github.com>
Co-authored-by: Lambros Petrou <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

product:durable-objects Durable Objects: https://developers.cloudflare.com/workers/learning/using-durable-objects/ product:workers Related to Workers product size/m

Projects

None yet

Development

Successfully merging this pull request may close these issues.

6 participants