Dumb Durable Object

This is a small package to ease the friction when communicating with a Durable Object binding. This package is under development and if you want to use it in any stable capacity I suggest you copy over the code and maintain it yourself. If you do any good improvements it'd be greatly appreciated if you can contribute back. There will likely be a lot of breaking packages when this package updates as it is in its infancy.

Usage

This is a simple example using the library.

Simple response

1// In your worker most likely
2class DurableObjectExample extends CallableDurableObject {
3  @callable // Decorator that ensures the type signature required for it to be callable
4  helloWorld(name: string) {
5    return ok(200, `Hello world, ${name}!`);
6  }
7}
8
9// In whoever is calling the worker, for example a pages function
10type Env = {
11  DO_EXAMPLE: DurableObjectNamespaceIs<DurableObjectExample>;
12};
13
14export async function onRequest({
15  request,
16  env,
17}: {
18  request: Request;
19  env: Env;
20}) {
21  const id = "MY_DO_ID"; // Could also be a DurableObjectId
22  const c = client(env.DO_EXAMPLE, id);
23  const response = await c.helloWorld("MY NAME"); // Absence of error makes the json() function always the successful one
24
25  const value = await response.json()
26
27  return new Response(value, { status: 200 });
28}

Error response

1// In your worker most likely
2class DurableObjectExample extends CallableDurableObject {
3  @callable // Decorator that ensures the type signature required for it to be callable
4  helloWorld(name: string) {
5    if (name === "") {
6      return error(422, { message: "Your name was empty!" });
7    }
8    return ok(200, `Hello world, ${name}!`);
9  }
10}
11
12// In whoever is calling the worker, for example a pages function
13type Env = {
14  DO_EXAMPLE: DurableObjectNamespaceIs<DurableObjectExample>;
15};
16
17export async function onRequest({
18  request,
19  env,
20}: {
21  request: Request;
22  env: Env;
23}) {
24  const id = "MY_DO_ID"; // Could also be a DurableObjectId
25  const c = client(env.DO_EXAMPLE, id);
26  const response = await c.helloWorld("MY NAME");
27
28  // Since it might return an error we have to disambiguate
29  if (!response.ok) {
30    const err = await response.json();
31    // value is of type { message: string }
32    return new Response(err.message, { status: response.status }); // Notice we get the error value here
33  }
34
35  const value = await response.json()
36  // value is of type string
37  return new Response(value, { status: response.status }); // Notice we get the successful value here
38}