Add reference documentation for DurableObjectState (#17471)

* 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]>

Author: 4 people

src/content/changelogs/workers.yaml

@@ -206,7 +206,7 @@ entries:
   - publish_date: "2023-05-05"
     description: |-
       - The new `nodeJsCompatModule` type can be used with a Worker bundle to emulate a Node.js environment. Common Node.js globals such as `process` and `Buffer` will be present, and `require('...')` can be used to load Node.js built-ins without the `node:` specifier prefix.
-      - Fixed an issue where websocket connections would be disconnected when updating workers. Now, only websockets connected to Durable Object instances are disconnected by updates to that Durable Object’s code.
+      - Fixed an issue where websocket connections would be disconnected when updating workers. Now, only WebSockets connected to Durable Objects are disconnected by updates to that Durable Object’s code.
   - publish_date: "2023-04-28"
     description: |-
       - The Web Crypto API now supports curves Ed25519 and X25519 defined in the Secure Curves specification.

src/content/docs/durable-objects/api/alarms.mdx

@@ -13,7 +13,7 @@ Durable Objects alarms allow you to schedule the Durable Object to be woken up a
 
 Notably:
 
-- Each Durable Object instance is able to schedule a single alarm at a time by calling `setAlarm()`.
+- Each Durable Object is able to schedule a single alarm at a time by calling `setAlarm()`.
 - Alarms have guaranteed at-least-once execution and are retried automatically when the `alarm()` handler throws.
 - Retries are performed using exponential backoff starting at a 2 second delay from the first failure with up to 6 retries allowed.
 

src/content/docs/durable-objects/api/id.mdx

@@ -9,13 +9,13 @@ import { Render, Tabs, TabItem } from "~/components";
 
 ## Description
 
-A Durable Object ID is a 64-digit hexadecimal number used to identify a Durable Object instance. Not all 64-digit hex numbers are valid IDs. Durable Object IDs are constructed indirectly via the [`DurableObjectNamespace`](/durable-objects/api/namespace) interface.
+A Durable Object ID is a 64-digit hexadecimal number used to identify a Durable Object. Not all 64-digit hex numbers are valid IDs. Durable Object IDs are constructed indirectly via the [`DurableObjectNamespace`](/durable-objects/api/namespace) interface.
 
-The `DurableObjectId` interface refers to a new or existing Durable Object instance. This interface is most frequently used by [`DurableObjectNamespace::get`](/durable-objects/api/namespace/#get) to obtain a [`DurableObjectStub`](/durable-objects/api/stub) for submitting requests to a Durable Object instance. Note that creating an ID for a Durable Object instance does not create the Durable Object. The Durable Object is created lazily after creating a stub from a `DurableObjectId`. This ensures that objects are not constructed until they are actually accessed.
+The `DurableObjectId` interface refers to a new or existing Durable Object. This interface is most frequently used by [`DurableObjectNamespace::get`](/durable-objects/api/namespace/#get) to obtain a [`DurableObjectStub`](/durable-objects/api/stub) for submitting requests to a Durable Object. Note that creating an ID for a Durable Object does not create the Durable Object. The Durable Object is created lazily after creating a stub from a `DurableObjectId`. This ensures that objects are not constructed until they are actually accessed.
 
 :::note[Logging]
 
-If you are experiencing an issue with a particular Durable Object instance, you may wish to log the `DurableObjectId` from your Worker and include it in your Cloudflare support request.
+If you are experiencing an issue with a particular Durable Object, you may wish to log the `DurableObjectId` from your Worker and include it in your Cloudflare support request.
 
 :::
 

src/content/docs/durable-objects/api/namespace.mdx

@@ -9,11 +9,11 @@ import { Render, Tabs, TabItem } from "~/components";
 
 ## Description
 
-A Durable Object namespace is a set of Durable Object instances that are backed by the same Durable Object class. There is only one Durable Object namespace per class. A Durable Object namespace can contain any number of Durable Object instances.
+A Durable Object namespace is a set of Durable Objects that are backed by the same Durable Object class. There is only one Durable Object namespace per class. A Durable Object namespace can contain any number of Durable Objects.
 
-The `DurableObjectNamespace` interface is used to obtain a reference to new or existing Durable Object instances. The interface is accessible from the fetch handler on a Cloudflare Worker via the `env` parameter, which is the standard interface when referencing bindings declared in `wrangler.toml`.
+The `DurableObjectNamespace` interface is used to obtain a reference to new or existing Durable Objects. The interface is accessible from the fetch handler on a Cloudflare Worker via the `env` parameter, which is the standard interface when referencing bindings declared in `wrangler.toml`.
 
-This interface defines several [methods](/durable-objects/api/namespace/#methods) that can be used to create an ID for a Durable Object instance. Note that creating an ID for a Durable Object instance does not create the Durable Object. The Durable Object is created lazily after calling [`DurableObjectNamespace::get`](/durable-objects/api/namespace/#get) to create a [`DurableObjectStub`](/durable-objects/api/stub) from a `DurableObjectId`. This ensures that objects are not constructed until they are actually accessed.
+This interface defines several [methods](/durable-objects/api/namespace/#methods) that can be used to create an ID for a Durable Object. Note that creating an ID for a Durable Object does not create the Durable Object. The Durable Object is created lazily after calling [`DurableObjectNamespace::get`](/durable-objects/api/namespace/#get) to create a [`DurableObjectStub`](/durable-objects/api/stub) from a `DurableObjectId`. This ensures that objects are not constructed until they are actually accessed.
 
 <Tabs> <TabItem label="JavaScript" icon="seti:javascript">
 
@@ -31,7 +31,7 @@ export default {
     // Every unique ID refers to an individual instance of the Durable Object class
     const id = env.MY_DURABLE_OBJECT.idFromName("foo");
 
-    // A stub is a client Object used to invoke methods defined by the Durable Object instance
+    // A stub is a client Object used to invoke methods defined by the Durable Object
     const stub = env.MY_DURABLE_OBJECT.get(id);
     ...
   }
@@ -58,7 +58,7 @@ export default {
     // Every unique ID refers to an individual instance of the Durable Object class
     const id = env.MY_DURABLE_OBJECT.idFromName("foo");
 
-    // A stub is a client Object used to invoke methods defined by the Durable Object instance
+    // A stub is a client Object used to invoke methods defined by the Durable Object
     const stub = env.MY_DURABLE_OBJECT.get(id);
     ...
   }
@@ -71,7 +71,7 @@ export default {
 
 ### `idFromName`
 
-`idFromName` creates a unique [`DurableObjectId`](/durable-objects/api/id) which refers to an individual instance of the Durable Object class. Named Durable Object instances are the most common method of referring to Durable Object instances.
+`idFromName` creates a unique [`DurableObjectId`](/durable-objects/api/id) which refers to an individual instance of the Durable Object class. Named Durable Objects are the most common method of referring to Durable Objects.
 
 ```js
 const fooId = env.MY_DURABLE_OBJECT.idFromName("foo");
@@ -80,15 +80,15 @@ const barId = env.MY_DURABLE_OBJECT.idFromName("bar");
 
 #### Parameters
 
-- A required string to be used to generate a [`DurableObjectId`](/durable-objects/api/id) corresponding to the name of a Durable Object instance.
+- A required string to be used to generate a [`DurableObjectId`](/durable-objects/api/id) corresponding to the name of a Durable Object.
 
 #### Return values
 
 - A [`DurableObjectId`](/durable-objects/api/id) referring to an instance of a Durable Object class.
 
 ### `newUniqueId`
 
-`newUniqueId` creates a randomly generated and unique [`DurableObjectId`](/durable-objects/api/id) which refers to an individual instance of the Durable Object class. IDs created using `newUniqueId`, will need to be stored as a string in order to refer to the same Durable Object again in the future. For example, the ID can be stored in Workers KV, another Durable Object instance, or in a cookie in the user's browser.
+`newUniqueId` creates a randomly generated and unique [`DurableObjectId`](/durable-objects/api/id) which refers to an individual instance of the Durable Object class. IDs created using `newUniqueId`, will need to be stored as a string in order to refer to the same Durable Object again in the future. For example, the ID can be stored in Workers KV, another Durable Object, or in a cookie in the user's browser.
 
 ```js
 const id = env.MY_DURABLE_OBJECT.newUniqueId();
@@ -99,7 +99,7 @@ const euId = env.MY_DURABLE_OBJECT.newUniqueId({ jurisdiction: "eu" });
 
 The first time you get a Durable Object stub based on an ID derived from a name, the system has to take into account the possibility that a Worker on the opposite side of the world could have coincidentally accessed the same named Durable Object at the same time. To guarantee that only one instance of the Durable Object is created, the system must check that the Durable Object has not been created anywhere else. Due to the inherent limit of the speed of light, this round-the-world check can take up to a few hundred milliseconds. `newUniqueId` can skip this check.
 
-After this first use, the location of the Durable Object instance will be cached around the world so that subsequent lookups are faster.
+After this first use, the location of the Durable Object will be cached around the world so that subsequent lookups are faster.
 
 :::
 
@@ -127,9 +127,9 @@ After this first use, the location of the Durable Object instance will be cached
 
 ### `get`
 
-`get` obtains a [`DurableObjectStub`](/durable-objects/api/stub) from a [`DurableObjectId`](/durable-objects/api/id) which can be used to invoke methods on a Durable Object instance.
+`get` obtains a [`DurableObjectStub`](/durable-objects/api/stub) from a [`DurableObjectId`](/durable-objects/api/id) which can be used to invoke methods on a Durable Object.
 
-This method returns the stub immediately, often before a connection has been established to the Durable Object instance. This allows requests to be sent to the instance right away, without waiting for a network round trip.
+This method returns the stub immediately, often before a connection has been established to the Durable Object. This allows requests to be sent to the instance right away, without waiting for a network round trip.
 
 ```js
 const id = env.MY_DURABLE_OBJECT.newUniqueId();
@@ -147,7 +147,7 @@ const stub = env.MY_DURABLE_OBJECT.get(id);
 
 ### `jurisdiction`
 
-`jurisdiction` creates a subnamespace from a namespace where all Durable Object instance IDs and references created from that subnamespace will be restricted to the specified [jurisdiction](/durable-objects/reference/data-location/#restrict-durable-objects-to-a-jurisdiction).
+`jurisdiction` creates a subnamespace from a namespace where all Durable Object IDs and references created from that subnamespace will be restricted to the specified [jurisdiction](/durable-objects/reference/data-location/#restrict-durable-objects-to-a-jurisdiction).
 
 ```js
 const subnamespace = env.MY_DURABLE_OBJECT.jurisdiction("foo");