Class DurableObject<Env, Props>Abstract

constructor

• new DurableObject<Env = Cloudflare.Env, Props = {}>(
      ctx: DurableObjectState,
      env: Env,
  ): CloudflareWorkersModule.DurableObject<Env, Props>

  Type Parameters

  • Env = Cloudflare.Env
  • Props = {}

  Parameters

  • ctx: DurableObjectState
  • env: Env

  Returns CloudflareWorkersModule.DurableObject<Env, Props>

__DURABLE_OBJECT_BRAND

Optionalalarm

• alarm?(alarmInfo?: AlarmInvocationInfo): void | Promise<void>

  Parameters

  • OptionalalarmInfo: AlarmInvocationInfo

  Returns void | Promise<void>

Optionalconnect

• connect?(socket: Socket): void | Promise<void>

  Parameters

  • socket: Socket

  Returns void | Promise<void>

Optionalfetch

• fetch?(request: Request): Response | Promise<Response>

  Parameters

  • request: Request

  Returns Response | Promise<Response>

OptionalwebSocketClose

• webSocketClose?(
      ws: WebSocket,
      code: number,
      reason: string,
      wasClean: boolean,
  ): void | Promise<void>

  Parameters

  • ws: WebSocket
  • code: number
  • reason: string
  • wasClean: boolean

  Returns void | Promise<void>

OptionalwebSocketError

• webSocketError?(ws: WebSocket, error: unknown): void | Promise<void>

  Parameters

  • ws: WebSocket
  • error: unknown

  Returns void | Promise<void>

OptionalwebSocketMessage

• webSocketMessage?(
      ws: WebSocket,
      message: string | ArrayBuffer,
  ): void | Promise<void>

  Parameters

  • ws: WebSocket
  • message: string | ArrayBuffer

  Returns void | Promise<void>