Interface DurableObjectState<Props>

interface DurableObjectState<Props = unknown> {
    container?: Container;
    exports: Cloudflare.Exports;
    facets: DurableObjectFacets;
    id: DurableObjectId;
    props: Props;
    storage: DurableObjectStorage;
    abort(reason?: string): void;
    acceptWebSocket(ws: WebSocket, tags?: string[]): void;
    blockConcurrencyWhile<T>(callback: () => Promise<T>): Promise<T>;
    getHibernatableWebSocketEventTimeout(): number | null;
    getTags(ws: WebSocket): string[];
    getWebSocketAutoResponse(): WebSocketRequestResponsePair | null;
    getWebSocketAutoResponseTimestamp(ws: WebSocket): Date | null;
    getWebSockets(tag?: string): WebSocket[];
    setHibernatableWebSocketEventTimeout(timeoutMs?: number): void;
    setWebSocketAutoResponse(maybeReqResp?: WebSocketRequestResponsePair): void;
    waitUntil(promise: Promise<any>): void;
}

Type Parameters

Props = unknown

Index

Properties

container? exports facets id props storage

Methods

abort acceptWebSocket blockConcurrencyWhile getHibernatableWebSocketEventTimeout getTags getWebSocketAutoResponse getWebSocketAutoResponseTimestamp getWebSockets setHibernatableWebSocketEventTimeout setWebSocketAutoResponse waitUntil

Properties

`Optional`container

container?: Container

`Readonly`exports

exports: Cloudflare.Exports

facets: DurableObjectFacets

`Readonly`id

id: DurableObjectId

`Readonly`props

props: Props

`Readonly`storage

storage: DurableObjectStorage

Methods

abort

abort(reason?: string): void
Parameters
- Optionalreason: string
Returns void
- Defined in src/server/worker-configuration.d.ts:577

acceptWebSocket

acceptWebSocket(ws: WebSocket, tags?: string[]): void
Parameters
- ws: WebSocket
- Optionaltags: string[]
Returns void
- Defined in src/server/worker-configuration.d.ts:569

blockConcurrencyWhile

blockConcurrencyWhile<T>(callback: () => Promise<T>): Promise<T>
Type Parameters
- T
Parameters
- callback: () => Promise<T>
Returns Promise<T>
- Defined in src/server/worker-configuration.d.ts:568

getHibernatableWebSocketEventTimeout

getHibernatableWebSocketEventTimeout(): number | null
Returns number | null
- Defined in src/server/worker-configuration.d.ts:575

getTags

getTags(ws: WebSocket): string[]
Parameters
- ws: WebSocket
Returns string[]
- Defined in src/server/worker-configuration.d.ts:576

getWebSocketAutoResponse

getWebSocketAutoResponse(): WebSocketRequestResponsePair | null
Returns WebSocketRequestResponsePair | null
- Defined in src/server/worker-configuration.d.ts:572

getWebSocketAutoResponseTimestamp

getWebSocketAutoResponseTimestamp(ws: WebSocket): Date | null
Parameters
- ws: WebSocket
Returns Date | null
- Defined in src/server/worker-configuration.d.ts:573

getWebSockets

getWebSockets(tag?: string): WebSocket[]
Parameters
- Optionaltag: string
Returns WebSocket[]
- Defined in src/server/worker-configuration.d.ts:570

setHibernatableWebSocketEventTimeout

setHibernatableWebSocketEventTimeout(timeoutMs?: number): void
Parameters
- OptionaltimeoutMs: number
Returns void
- Defined in src/server/worker-configuration.d.ts:574

setWebSocketAutoResponse

setWebSocketAutoResponse(maybeReqResp?: WebSocketRequestResponsePair): void
Parameters
- OptionalmaybeReqResp: WebSocketRequestResponsePair
Returns void
- Defined in src/server/worker-configuration.d.ts:571

waitUntil

waitUntil(promise: Promise<any>): void
Parameters
- promise: Promise<any>
Returns void
- Defined in src/server/worker-configuration.d.ts:561