@cloudflare/workers-types 4.20230419.0 → 4.20230518.0

package/2021-11-03/index.d.ts

@@ -184,6 +184,8 @@ declare interface ServiceWorkerGlobalScope extends WorkerGlobalScope {
   crypto: Crypto;
   caches: CacheStorage;
   scheduler: Scheduler;
+  performance: Performance;
+  readonly origin: string;
   Event: typeof Event;
   ExtendableEvent: typeof ExtendableEvent;
   PromiseRejectionEvent: typeof PromiseRejectionEvent;
@@ -281,6 +283,8 @@ declare const self: ServiceWorkerGlobalScope;
 declare const crypto: Crypto;
 declare const caches: CacheStorage;
 declare const scheduler: Scheduler;
+declare const performance: Performance;
+declare const origin: string;
 declare interface TestController {}
 declare interface ExecutionContext {
   waitUntil(promise: Promise<any>): void;
@@ -338,6 +342,11 @@ declare abstract class PromiseRejectionEvent extends Event {
   readonly promise: Promise<any>;
   readonly reason: any;
 }
+/** Provides access to performance-related information for the current page. It's part of the High Resolution Time API, but is enhanced by the Performance Timeline API, the Navigation Timing API, the User Timing API, and the Resource Timing API. */
+declare interface Performance {
+  readonly timeOrigin: number;
+  now(): number;
+}
 declare interface DurableObject {
   fetch(request: Request): Response | Promise<Response>;
   alarm?(): void | Promise<void>;
@@ -385,6 +394,8 @@ declare interface DurableObjectState {
   readonly id: DurableObjectId;
   readonly storage: DurableObjectStorage;
   blockConcurrencyWhile<T>(callback: () => Promise<T>): Promise<T>;
+  acceptWebSocket(ws: WebSocket, tags?: string[]): void;
+  getWebSockets(tag?: string): WebSocket[];
 }
 declare interface DurableObjectTransaction {
   get<T = unknown>(
@@ -451,6 +462,7 @@ declare interface DurableObjectStorage {
   ): Promise<void>;
   deleteAlarm(options?: DurableObjectSetAlarmOptions): Promise<void>;
   sync(): Promise<void>;
+  transactionSync<T>(closure: () => T): T;
 }
 declare interface DurableObjectListOptions {
   start?: string;
@@ -571,6 +583,7 @@ declare class AbortController {
 declare abstract class AbortSignal extends EventTarget {
   static abort(reason?: any): AbortSignal;
   static timeout(delay: number): AbortSignal;
+  static any(signals: AbortSignal[]): AbortSignal;
   /** Returns true if this AbortSignal's AbortController has signaled to abort, and false otherwise. */
   readonly aborted: boolean;
   readonly reason: any;
@@ -1066,6 +1079,7 @@ declare interface RequestInit<Cf = CfProperties> {
 }
 declare abstract class Fetcher {
   fetch(input: RequestInfo, init?: RequestInit): Promise<Response>;
+  connect(address: SocketAddress | string, options?: SocketOptions): Socket;
 }
 declare interface FetcherPutOptions {
   expiration?: number;
@@ -1839,6 +1853,8 @@ declare class WebSocket extends EventTarget<WebSocketEventMap> {
   accept(): void;
   send(message: (ArrayBuffer | ArrayBufferView) | string): void;
   close(code?: number, reason?: string): void;
+  serializeAttachment(attachment: any): void;
+  deserializeAttachment(): any | null;
   static readonly READY_STATE_CONNECTING: number;
   static readonly READY_STATE_OPEN: number;
   static readonly READY_STATE_CLOSING: number;
@@ -1858,6 +1874,24 @@ declare const WebSocketPair: {
     1: WebSocket;
   };
 };
+declare interface Socket {
+  get readable(): ReadableStream;
+  get writable(): WritableStream;
+  get closed(): Promise<void>;
+  close(): Promise<void>;
+  startTls(options?: TlsOptions): Socket;
+}
+declare interface SocketOptions {
+  secureTransport?: string;
+  allowHalfOpen: boolean;
+}
+declare interface SocketAddress {
+  hostname: string;
+  port: number;
+}
+declare interface TlsOptions {
+  expectedServerHostname?: string;
+}
 declare interface BasicImageTransformations {
   /**
    * Maximum width in image pixels. The value must be an integer.
@@ -2992,12 +3026,49 @@ declare interface JsonWebKeyWithKid extends JsonWebKey {
   // Key Identifier of the JWK
   readonly kid: string;
 }
+declare module "cloudflare:sockets" {
+  function _connect(
+    address: string | SocketAddress,
+    options?: SocketOptions
+  ): Socket;
+  export { _connect as connect };
+}
 // https://developers.cloudflare.com/cloudflare-for-platforms/workers-for-platforms/
+declare interface DynamicDispatchLimits {
+  /**
+   * Limit CPU time in milliseconds.
+   */
+  cpuMs?: number;
+  /**
+   * Limit number of subrequests.
+   */
+  subRequests?: number;
+}
+declare interface DynamicDispatchOptions {
+  /**
+   * Limit resources of invoked Worker script.
+   */
+  limits?: DynamicDispatchLimits;
+  /**
+   * Arguments for outbound Worker script, if configured.
+   */
+  outbound?: {
+    [key: string]: any;
+  };
+}
 declare interface DispatchNamespace {
   /**
    * @param name Name of the Worker script.
+   * @param args Arguments to Worker script.
+   * @param options Options for Dynamic Dispatch invocation.
    * @returns A Fetcher object that allows you to send requests to the Worker script.
    * @throws If the Worker script does not exist in this dispatch namespace, an error will be thrown.
    */
-  get(name: string): Fetcher;
+  get(
+    name: string,
+    args?: {
+      [key: string]: any;
+    },
+    options?: DynamicDispatchOptions
+  ): Fetcher;
 }

package/2021-11-03/index.ts

@@ -184,6 +184,8 @@ export interface ServiceWorkerGlobalScope extends WorkerGlobalScope {
   crypto: Crypto;
   caches: CacheStorage;
   scheduler: Scheduler;
+  performance: Performance;
+  readonly origin: string;
   Event: typeof Event;
   ExtendableEvent: typeof ExtendableEvent;
   PromiseRejectionEvent: typeof PromiseRejectionEvent;
@@ -283,6 +285,8 @@ export declare const self: ServiceWorkerGlobalScope;
 export declare const crypto: Crypto;
 export declare const caches: CacheStorage;
 export declare const scheduler: Scheduler;
+export declare const performance: Performance;
+export declare const origin: string;
 export interface TestController {}
 export interface ExecutionContext {
   waitUntil(promise: Promise<any>): void;
@@ -340,6 +344,11 @@ export declare abstract class PromiseRejectionEvent extends Event {
   readonly promise: Promise<any>;
   readonly reason: any;
 }
+/** Provides access to performance-related information for the current page. It's part of the High Resolution Time API, but is enhanced by the Performance Timeline API, the Navigation Timing API, the User Timing API, and the Resource Timing API. */
+export interface Performance {
+  readonly timeOrigin: number;
+  now(): number;
+}
 export interface DurableObject {
   fetch(request: Request): Response | Promise<Response>;
   alarm?(): void | Promise<void>;
@@ -387,6 +396,8 @@ export interface DurableObjectState {
   readonly id: DurableObjectId;
   readonly storage: DurableObjectStorage;
   blockConcurrencyWhile<T>(callback: () => Promise<T>): Promise<T>;
+  acceptWebSocket(ws: WebSocket, tags?: string[]): void;
+  getWebSockets(tag?: string): WebSocket[];
 }
 export interface DurableObjectTransaction {
   get<T = unknown>(
@@ -453,6 +464,7 @@ export interface DurableObjectStorage {
   ): Promise<void>;
   deleteAlarm(options?: DurableObjectSetAlarmOptions): Promise<void>;
   sync(): Promise<void>;
+  transactionSync<T>(closure: () => T): T;
 }
 export interface DurableObjectListOptions {
   start?: string;
@@ -573,6 +585,7 @@ export declare class AbortController {
 export declare abstract class AbortSignal extends EventTarget {
   static abort(reason?: any): AbortSignal;
   static timeout(delay: number): AbortSignal;
+  static any(signals: AbortSignal[]): AbortSignal;
   /** Returns true if this AbortSignal's AbortController has signaled to abort, and false otherwise. */
   readonly aborted: boolean;
   readonly reason: any;
@@ -1068,6 +1081,7 @@ export interface RequestInit<Cf = CfProperties> {
 }
 export declare abstract class Fetcher {
   fetch(input: RequestInfo, init?: RequestInit): Promise<Response>;
+  connect(address: SocketAddress | string, options?: SocketOptions): Socket;
 }
 export interface FetcherPutOptions {
   expiration?: number;
@@ -1844,6 +1858,8 @@ export declare class WebSocket extends EventTarget<WebSocketEventMap> {
   accept(): void;
   send(message: (ArrayBuffer | ArrayBufferView) | string): void;
   close(code?: number, reason?: string): void;
+  serializeAttachment(attachment: any): void;
+  deserializeAttachment(): any | null;
   static readonly READY_STATE_CONNECTING: number;
   static readonly READY_STATE_OPEN: number;
   static readonly READY_STATE_CLOSING: number;
@@ -1863,6 +1879,24 @@ export declare const WebSocketPair: {
     1: WebSocket;
   };
 };
+export interface Socket {
+  get readable(): ReadableStream;
+  get writable(): WritableStream;
+  get closed(): Promise<void>;
+  close(): Promise<void>;
+  startTls(options?: TlsOptions): Socket;
+}
+export interface SocketOptions {
+  secureTransport?: string;
+  allowHalfOpen: boolean;
+}
+export interface SocketAddress {
+  hostname: string;
+  port: number;
+}
+export interface TlsOptions {
+  expectedServerHostname?: string;
+}
 export interface BasicImageTransformations {
   /**
    * Maximum width in image pixels. The value must be an integer.
@@ -2988,11 +3022,41 @@ export interface JsonWebKeyWithKid extends JsonWebKey {
   readonly kid: string;
 }
 // https://developers.cloudflare.com/cloudflare-for-platforms/workers-for-platforms/
+export interface DynamicDispatchLimits {
+  /**
+   * Limit CPU time in milliseconds.
+   */
+  cpuMs?: number;
+  /**
+   * Limit number of subrequests.
+   */
+  subRequests?: number;
+}
+export interface DynamicDispatchOptions {
+  /**
+   * Limit resources of invoked Worker script.
+   */
+  limits?: DynamicDispatchLimits;
+  /**
+   * Arguments for outbound Worker script, if configured.
+   */
+  outbound?: {
+    [key: string]: any;
+  };
+}
 export interface DispatchNamespace {
   /**
    * @param name Name of the Worker script.
+   * @param args Arguments to Worker script.
+   * @param options Options for Dynamic Dispatch invocation.
    * @returns A Fetcher object that allows you to send requests to the Worker script.
    * @throws If the Worker script does not exist in this dispatch namespace, an error will be thrown.
    */
-  get(name: string): Fetcher;
+  get(
+    name: string,
+    args?: {
+      [key: string]: any;
+    },
+    options?: DynamicDispatchOptions
+  ): Fetcher;
 }

package/2022-01-31/index.d.ts

@@ -184,6 +184,8 @@ declare interface ServiceWorkerGlobalScope extends WorkerGlobalScope {
   crypto: Crypto;
   caches: CacheStorage;
   scheduler: Scheduler;
+  performance: Performance;
+  readonly origin: string;
   Event: typeof Event;
   ExtendableEvent: typeof ExtendableEvent;
   PromiseRejectionEvent: typeof PromiseRejectionEvent;
@@ -281,6 +283,8 @@ declare const self: ServiceWorkerGlobalScope;
 declare const crypto: Crypto;
 declare const caches: CacheStorage;
 declare const scheduler: Scheduler;
+declare const performance: Performance;
+declare const origin: string;
 declare interface TestController {}
 declare interface ExecutionContext {
   waitUntil(promise: Promise<any>): void;
@@ -338,6 +342,11 @@ declare abstract class PromiseRejectionEvent extends Event {
   readonly promise: Promise<any>;
   readonly reason: any;
 }
+/** Provides access to performance-related information for the current page. It's part of the High Resolution Time API, but is enhanced by the Performance Timeline API, the Navigation Timing API, the User Timing API, and the Resource Timing API. */
+declare interface Performance {
+  readonly timeOrigin: number;
+  now(): number;
+}
 declare interface DurableObject {
   fetch(request: Request): Response | Promise<Response>;
   alarm?(): void | Promise<void>;
@@ -385,6 +394,8 @@ declare interface DurableObjectState {
   readonly id: DurableObjectId;
   readonly storage: DurableObjectStorage;
   blockConcurrencyWhile<T>(callback: () => Promise<T>): Promise<T>;
+  acceptWebSocket(ws: WebSocket, tags?: string[]): void;
+  getWebSockets(tag?: string): WebSocket[];
 }
 declare interface DurableObjectTransaction {
   get<T = unknown>(
@@ -451,6 +462,7 @@ declare interface DurableObjectStorage {
   ): Promise<void>;
   deleteAlarm(options?: DurableObjectSetAlarmOptions): Promise<void>;
   sync(): Promise<void>;
+  transactionSync<T>(closure: () => T): T;
 }
 declare interface DurableObjectListOptions {
   start?: string;
@@ -560,6 +572,7 @@ declare class AbortController {
 declare abstract class AbortSignal extends EventTarget {
   static abort(reason?: any): AbortSignal;
   static timeout(delay: number): AbortSignal;
+  static any(signals: AbortSignal[]): AbortSignal;
   get aborted(): boolean;
   get reason(): any;
   throwIfAborted(): void;
@@ -1046,6 +1059,7 @@ declare interface RequestInit<Cf = CfProperties> {
 }
 declare abstract class Fetcher {
   fetch(input: RequestInfo, init?: RequestInit): Promise<Response>;
+  connect(address: SocketAddress | string, options?: SocketOptions): Socket;
 }
 declare interface FetcherPutOptions {
   expiration?: number;
@@ -1829,6 +1843,8 @@ declare class WebSocket extends EventTarget<WebSocketEventMap> {
   accept(): void;
   send(message: (ArrayBuffer | ArrayBufferView) | string): void;
   close(code?: number, reason?: string): void;
+  serializeAttachment(attachment: any): void;
+  deserializeAttachment(): any | null;
   static readonly READY_STATE_CONNECTING: number;
   static readonly READY_STATE_OPEN: number;
   static readonly READY_STATE_CLOSING: number;
@@ -1844,6 +1860,24 @@ declare const WebSocketPair: {
     1: WebSocket;
   };
 };
+declare interface Socket {
+  get readable(): ReadableStream;
+  get writable(): WritableStream;
+  get closed(): Promise<void>;
+  close(): Promise<void>;
+  startTls(options?: TlsOptions): Socket;
+}
+declare interface SocketOptions {
+  secureTransport?: string;
+  allowHalfOpen: boolean;
+}
+declare interface SocketAddress {
+  hostname: string;
+  port: number;
+}
+declare interface TlsOptions {
+  expectedServerHostname?: string;
+}
 declare interface BasicImageTransformations {
   /**
    * Maximum width in image pixels. The value must be an integer.
@@ -2978,12 +3012,49 @@ declare interface JsonWebKeyWithKid extends JsonWebKey {
   // Key Identifier of the JWK
   readonly kid: string;
 }
+declare module "cloudflare:sockets" {
+  function _connect(
+    address: string | SocketAddress,
+    options?: SocketOptions
+  ): Socket;
+  export { _connect as connect };
+}
 // https://developers.cloudflare.com/cloudflare-for-platforms/workers-for-platforms/
+declare interface DynamicDispatchLimits {
+  /**
+   * Limit CPU time in milliseconds.
+   */
+  cpuMs?: number;
+  /**
+   * Limit number of subrequests.
+   */
+  subRequests?: number;
+}
+declare interface DynamicDispatchOptions {
+  /**
+   * Limit resources of invoked Worker script.
+   */
+  limits?: DynamicDispatchLimits;
+  /**
+   * Arguments for outbound Worker script, if configured.
+   */
+  outbound?: {
+    [key: string]: any;
+  };
+}
 declare interface DispatchNamespace {
   /**
    * @param name Name of the Worker script.
+   * @param args Arguments to Worker script.
+   * @param options Options for Dynamic Dispatch invocation.
    * @returns A Fetcher object that allows you to send requests to the Worker script.
    * @throws If the Worker script does not exist in this dispatch namespace, an error will be thrown.
    */
-  get(name: string): Fetcher;
+  get(
+    name: string,
+    args?: {
+      [key: string]: any;
+    },
+    options?: DynamicDispatchOptions
+  ): Fetcher;
 }

package/2022-01-31/index.ts

@@ -184,6 +184,8 @@ export interface ServiceWorkerGlobalScope extends WorkerGlobalScope {
   crypto: Crypto;
   caches: CacheStorage;
   scheduler: Scheduler;
+  performance: Performance;
+  readonly origin: string;
   Event: typeof Event;
   ExtendableEvent: typeof ExtendableEvent;
   PromiseRejectionEvent: typeof PromiseRejectionEvent;
@@ -283,6 +285,8 @@ export declare const self: ServiceWorkerGlobalScope;
 export declare const crypto: Crypto;
 export declare const caches: CacheStorage;
 export declare const scheduler: Scheduler;
+export declare const performance: Performance;
+export declare const origin: string;
 export interface TestController {}
 export interface ExecutionContext {
   waitUntil(promise: Promise<any>): void;
@@ -340,6 +344,11 @@ export declare abstract class PromiseRejectionEvent extends Event {
   readonly promise: Promise<any>;
   readonly reason: any;
 }
+/** Provides access to performance-related information for the current page. It's part of the High Resolution Time API, but is enhanced by the Performance Timeline API, the Navigation Timing API, the User Timing API, and the Resource Timing API. */
+export interface Performance {
+  readonly timeOrigin: number;
+  now(): number;
+}
 export interface DurableObject {
   fetch(request: Request): Response | Promise<Response>;
   alarm?(): void | Promise<void>;
@@ -387,6 +396,8 @@ export interface DurableObjectState {
   readonly id: DurableObjectId;
   readonly storage: DurableObjectStorage;
   blockConcurrencyWhile<T>(callback: () => Promise<T>): Promise<T>;
+  acceptWebSocket(ws: WebSocket, tags?: string[]): void;
+  getWebSockets(tag?: string): WebSocket[];
 }
 export interface DurableObjectTransaction {
   get<T = unknown>(
@@ -453,6 +464,7 @@ export interface DurableObjectStorage {
   ): Promise<void>;
   deleteAlarm(options?: DurableObjectSetAlarmOptions): Promise<void>;
   sync(): Promise<void>;
+  transactionSync<T>(closure: () => T): T;
 }
 export interface DurableObjectListOptions {
   start?: string;
@@ -562,6 +574,7 @@ export declare class AbortController {
 export declare abstract class AbortSignal extends EventTarget {
   static abort(reason?: any): AbortSignal;
   static timeout(delay: number): AbortSignal;
+  static any(signals: AbortSignal[]): AbortSignal;
   get aborted(): boolean;
   get reason(): any;
   throwIfAborted(): void;
@@ -1048,6 +1061,7 @@ export interface RequestInit<Cf = CfProperties> {
 }
 export declare abstract class Fetcher {
   fetch(input: RequestInfo, init?: RequestInit): Promise<Response>;
+  connect(address: SocketAddress | string, options?: SocketOptions): Socket;
 }
 export interface FetcherPutOptions {
   expiration?: number;
@@ -1834,6 +1848,8 @@ export declare class WebSocket extends EventTarget<WebSocketEventMap> {
   accept(): void;
   send(message: (ArrayBuffer | ArrayBufferView) | string): void;
   close(code?: number, reason?: string): void;
+  serializeAttachment(attachment: any): void;
+  deserializeAttachment(): any | null;
   static readonly READY_STATE_CONNECTING: number;
   static readonly READY_STATE_OPEN: number;
   static readonly READY_STATE_CLOSING: number;
@@ -1849,6 +1865,24 @@ export declare const WebSocketPair: {
     1: WebSocket;
   };
 };
+export interface Socket {
+  get readable(): ReadableStream;
+  get writable(): WritableStream;
+  get closed(): Promise<void>;
+  close(): Promise<void>;
+  startTls(options?: TlsOptions): Socket;
+}
+export interface SocketOptions {
+  secureTransport?: string;
+  allowHalfOpen: boolean;
+}
+export interface SocketAddress {
+  hostname: string;
+  port: number;
+}
+export interface TlsOptions {
+  expectedServerHostname?: string;
+}
 export interface BasicImageTransformations {
   /**
    * Maximum width in image pixels. The value must be an integer.
@@ -2974,11 +3008,41 @@ export interface JsonWebKeyWithKid extends JsonWebKey {
   readonly kid: string;
 }
 // https://developers.cloudflare.com/cloudflare-for-platforms/workers-for-platforms/
+export interface DynamicDispatchLimits {
+  /**
+   * Limit CPU time in milliseconds.
+   */
+  cpuMs?: number;
+  /**
+   * Limit number of subrequests.
+   */
+  subRequests?: number;
+}
+export interface DynamicDispatchOptions {
+  /**
+   * Limit resources of invoked Worker script.
+   */
+  limits?: DynamicDispatchLimits;
+  /**
+   * Arguments for outbound Worker script, if configured.
+   */
+  outbound?: {
+    [key: string]: any;
+  };
+}
 export interface DispatchNamespace {
   /**
    * @param name Name of the Worker script.
+   * @param args Arguments to Worker script.
+   * @param options Options for Dynamic Dispatch invocation.
    * @returns A Fetcher object that allows you to send requests to the Worker script.
    * @throws If the Worker script does not exist in this dispatch namespace, an error will be thrown.
    */
-  get(name: string): Fetcher;
+  get(
+    name: string,
+    args?: {
+      [key: string]: any;
+    },
+    options?: DynamicDispatchOptions
+  ): Fetcher;
 }