Class DurableObjectRouter<E>

Router for Cloudflare Durable Objects with class-based handlers and state management

Example

export class Counter implements DurableObject {
  private router: DurableObjectRouter<Env>;

  constructor(ctx: DurableObjectState, env: Env) {
    this.router = new DurableObjectRouter(ctx, env, 'counter')
      .defineRouteHandler('/count', CounterHandler)
      .defineRouteHandler('/reset', ResetHandler);
  }

  async fetch(request: Request): Promise<Response> {
    return this.router.handle(request);
  }
}

Type Parameters

E extends Env
Environment type extending base Env interface

Index

Constructors

constructor

new DurableObjectRouter<E extends Env>(
    ctx: DurableObjectState,
    env: E,
    name: string,
    ...args: [RouterOptions<unknown, any[]>?],
): DurableObjectRouter<E>
Create a new DurableObjectRouter
Type Parameters
- E extends Env
Parameters
- ctx: DurableObjectState
  Durable Object state
- env: E
  Environment bindings
- name: string
  Router name for logging
- ...args: [RouterOptions<unknown, any[]>?]
  Additional arguments passed to itty-router
Returns DurableObjectRouter<E>
- Defined in router.ts:659

Properties

log

log: Logger

Logger instance

name

name: string

Router name for logging

router

router: RouterType<unknown>

Underlying itty-router instance

ctx

ctx: DurableObjectState

Durable Object state

env

env: E

Environment bindings

Methods

all

all<P extends Params = Params>(
path: string,
middleware: DurableObjectMiddleware<P>,
): DurableObjectRouter<E>
Type Parameters
- P extends Params = Params
Parameters
- path: string
- middleware: DurableObjectMiddleware<P>
Returns DurableObjectRouter<E>
- Defined in router.ts:677

get

get(path: string, middleware: DurableObjectMiddleware): DurableObjectRouter<E>
Parameters
- path: string
- middleware: DurableObjectMiddleware
Returns DurableObjectRouter<E>
- Defined in router.ts:685

post

post(path: string, middleware: DurableObjectMiddleware): DurableObjectRouter<E>
Parameters
- path: string
- middleware: DurableObjectMiddleware
Returns DurableObjectRouter<E>
- Defined in router.ts:690

put

put(path: string, middleware: DurableObjectMiddleware): DurableObjectRouter<E>
Parameters
- path: string
- middleware: DurableObjectMiddleware
Returns DurableObjectRouter<E>
- Defined in router.ts:695

delete

delete(
path: string,
middleware: DurableObjectMiddleware,
): DurableObjectRouter<E>
Parameters
- path: string
- middleware: DurableObjectMiddleware
Returns DurableObjectRouter<E>
- Defined in router.ts:700

patch

patch(path: string, middleware: DurableObjectMiddleware): DurableObjectRouter<E>
Parameters
- path: string
- middleware: DurableObjectMiddleware
Returns DurableObjectRouter<E>
- Defined in router.ts:705

defineRouteHandler

defineRouteHandler(
    path: string,
    handler_cls: new (
        ...args: [
            path: string,
            ctx: DurableObjectState<unknown>,
            env: Env,
            options?: { log?: Logger },
        ],
    ) => DurableObjectRouteHandler<E>,
): DurableObjectRouter<E>
Parameters
- path: string
- handler_cls: new (
      ...args: [
          path: string,
          ctx: DurableObjectState<unknown>,
          env: Env,
          options?: { log?: Logger },
      ],
  ) => DurableObjectRouteHandler<E>
Returns DurableObjectRouter<E>
- Defined in router.ts:710

build

build(): RouterType<unknown, any[], unknown>
Returns RouterType<unknown, any[], unknown>
- Defined in router.ts:763

handle

handle(request: Request): Promise<Response>
Handle a request using the router

Automatically builds the router if not already built.
Parameters
- request: Request
  The request to handle
Returns Promise<Response>
A response promise
Example
```
async fetch(request: Request): Promise<Response> {
  return this.router.handle(request);
}
```
- Defined in router.ts:801

Class DurableObjectRouter<E>

Example

Type Parameters

Index

Constructors

Properties

Methods

Constructors

constructor

Type Parameters

Parameters

Returns DurableObjectRouter<E>

Properties

log

name

router

ctx

env

Methods

all

Type Parameters

Parameters

Returns DurableObjectRouter<E>

get

Parameters

Returns DurableObjectRouter<E>

post

Parameters

Returns DurableObjectRouter<E>

put

Parameters

Returns DurableObjectRouter<E>

delete

Parameters

Returns DurableObjectRouter<E>

patch

Parameters

Returns DurableObjectRouter<E>

defineRouteHandler

Parameters

Returns DurableObjectRouter<E>

build

Returns RouterType<unknown, any[], unknown>

handle

Parameters

Returns Promise<Response>

Example

Settings

On This Page