Class DurableObjectRouter<E>

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

Example

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

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

  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>(
 doState: DurableObjectState,
 env: E,
 name: string,
 options?: DurableObjectRouterOptions,
 ...args: [RouterOptions<unknown, any[]>?],
): DurableObjectRouter<E>
Type Parameters
- E extends Env
Parameters
- doState: DurableObjectState
- env: E
- name: string
- Optionaloptions: DurableObjectRouterOptions
- ...args: [RouterOptions<unknown, any[]>?]
Returns DurableObjectRouter<E>
- Defined in router.ts:967

Properties

log

log: Logger

Logger instance

name

name: string

Router name for logging

router

router: RouterType<unknown>

Underlying itty-router instance

doState

doState: DurableObjectState

Durable Object state

env

env: E

Environment bindings

`Optional`corsConfig

corsConfig?: CorsConfig<unknown, unknown>

CORS configuration

Methods

use

use>(
pathOrMiddleware: string | DurableObjectMiddleware<P, D>,
middleware?: DurableObjectMiddleware<P, D>,
): DurableObjectRouter<E>
Register global middleware or path-specific middleware
Type Parameters
- P extends Params = Params
- D = Record<string, any>
Parameters
- pathOrMiddleware: string | DurableObjectMiddleware<P, D>
- Optionalmiddleware: DurableObjectMiddleware<P, D>
Returns DurableObjectRouter<E>
- Defined in router.ts:986

all

all>(
path: string,
middleware: DurableObjectMiddleware<P, D>,
): DurableObjectRouter<E>
Type Parameters
- P extends Params = Params
- D = Record<string, any>
Parameters
- path: string
- middleware: DurableObjectMiddleware<P, D>
Returns DurableObjectRouter<E>
Deprecated
Use .use() instead
- Defined in router.ts:1010

get

get>(
path: string,
middleware: DurableObjectMiddleware<P, D>,
): DurableObjectRouter<E>
Type Parameters
- P extends Params = Params
- D = Record<string, any>
Parameters
- path: string
- middleware: DurableObjectMiddleware<P, D>
Returns DurableObjectRouter<E>
Deprecated
Use .use() or .defineRouteHandler()
- Defined in router.ts:1018

post

post>(
path: string,
middleware: DurableObjectMiddleware<P, D>,
): DurableObjectRouter<E>
Type Parameters
- P extends Params = Params
- D = Record<string, any>
Parameters
- path: string
- middleware: DurableObjectMiddleware<P, D>
Returns DurableObjectRouter<E>
Deprecated
Use .use() or .defineRouteHandler()
- Defined in router.ts:1031

put

put>(
path: string,
middleware: DurableObjectMiddleware<P, D>,
): DurableObjectRouter<E>
Type Parameters
- P extends Params = Params
- D = Record<string, any>
Parameters
- path: string
- middleware: DurableObjectMiddleware<P, D>
Returns DurableObjectRouter<E>
Deprecated
Use .use() or .defineRouteHandler()
- Defined in router.ts:1044

delete

delete>(
path: string,
middleware: DurableObjectMiddleware<P, D>,
): DurableObjectRouter<E>
Type Parameters
- P extends Params = Params
- D = Record<string, any>
Parameters
- path: string
- middleware: DurableObjectMiddleware<P, D>
Returns DurableObjectRouter<E>
Deprecated
Use .use() or .defineRouteHandler()
- Defined in router.ts:1057

patch

patch>(
path: string,
middleware: DurableObjectMiddleware<P, D>,
): DurableObjectRouter<E>
Type Parameters
- P extends Params = Params
- D = Record<string, any>
Parameters
- path: string
- middleware: DurableObjectMiddleware<P, D>
Returns DurableObjectRouter<E>
Deprecated
Use .use() or .defineRouteHandler()
- Defined in router.ts:1070

defineRouteHandler

defineRouteHandler>(
 path: string,
 handler_cls: new (
 doState: DurableObjectState,
 env: E,
 path: string,
 options?: { log?: Logger },
 ) => DurableObjectRouteHandler<E, P, D>,
): DurableObjectRouter<E>
Type Parameters
- P extends Params = Params
- D = Record<string, any>
Parameters
- path: string
- handler_cls: new (
 doState: DurableObjectState,
 env: E,
 path: string,
 options?: { log?: Logger },
 ) => DurableObjectRouteHandler<E, P, D>
Returns DurableObjectRouter<E>
- Defined in router.ts:1082

build

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

handle

handle(request: Request): Promise<Response>
Parameters
- request: Request
Returns Promise<Response>
- Defined in router.ts:1313

Class DurableObjectRouter<E>

Example

Type Parameters

Index

Constructors

Properties

Methods

Constructors

constructor

Type Parameters

Parameters

Returns DurableObjectRouter<E>

Properties

log

name

router

doState

env

OptionalcorsConfig

Methods

use

Type Parameters

Parameters

Returns DurableObjectRouter<E>

all

Type Parameters

Parameters

Returns DurableObjectRouter<E>

Deprecated

get

Type Parameters

Parameters

Returns DurableObjectRouter<E>

Deprecated

post

Type Parameters

Parameters

Returns DurableObjectRouter<E>

Deprecated

put

Type Parameters

Parameters

Returns DurableObjectRouter<E>

Deprecated

delete

Type Parameters

Parameters

Returns DurableObjectRouter<E>

Deprecated

patch

Type Parameters

Parameters

Returns DurableObjectRouter<E>

Deprecated

defineRouteHandler

Type Parameters

Parameters

Returns DurableObjectRouter<E>

build

Returns RouterType<unknown, any[], unknown>

handle

Parameters

Returns Promise<Response>

Settings

On This Page

`Optional`corsConfig