npm - @cloudflare/workers-types - Versions diffs - 4.20240208.0 → 4.20240312.0 - Mend

@cloudflare/workers-types 4.20240208.0 → 4.20240312.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (23) hide show

package/experimental/index.d.ts CHANGED Viewed

@@ -308,6 +308,7 @@ declare interface TestController {}
 declare interface ExecutionContext {
   waitUntil(promise: Promise<any>): void;
   passThroughOnException(): void;
+  abort(reason?: any): void;
 }
 declare type ExportedHandlerFetchHandler<
   Env = unknown,
@@ -381,6 +382,10 @@ declare interface Performance {
   readonly timeOrigin: number;
   now(): number;
 }
+declare interface AlarmInvocationInfo {
+  readonly isRetry: boolean;
+  readonly retryCount: number;
+}
 declare interface DurableObject {
   fetch(request: Request): Response | Promise<Response>;
   alarm?(): void | Promise<void>;
@@ -396,7 +401,7 @@ declare interface DurableObject {
   ): void | Promise<void>;
   webSocketError?(ws: WebSocket, error: unknown): void | Promise<void>;
 }
-declare interface DurableObjectStub extends WorkerRpc {
+declare interface DurableObjectStub extends Fetcher {
   readonly id: DurableObjectId;
   readonly name?: string;
 }
@@ -651,9 +656,9 @@ declare interface SchedulerWaitOptions {
 declare abstract class ExtendableEvent extends Event {
   waitUntil(promise: Promise<any>): void;
 }
-declare class CustomEvent extends Event {
+declare class CustomEvent<T = any> extends Event {
   constructor(type: string, init?: CustomEventCustomEventInit);
-  get detail(): any | undefined;
+  get detail(): T;
 }
 declare interface CustomEventCustomEventInit {
   bubbles?: boolean;
@@ -1144,10 +1149,7 @@ declare abstract class Fetcher {
     messages: ServiceBindingQueueMessage[]
   ): Promise<FetcherQueueResult>;
   scheduled(options?: FetcherScheduledOptions): Promise<FetcherScheduledResult>;
-}
-declare interface FetcherPutOptions {
-  expiration?: number;
-  expirationTtl?: number;
+  getRpcMethodForTestOnly(name: string): JsRpcProperty | null;
 }
 declare interface FetcherScheduledOptions {
   scheduledTime?: Date;
@@ -1159,10 +1161,10 @@ declare interface FetcherScheduledResult {
 }
 declare interface FetcherQueueResult {
   outcome: string;
-  retryAll: boolean;
   ackAll: boolean;
-  explicitRetries: string[];
+  retryBatch: QueueRetryBatch;
   explicitAcks: string[];
+  retryMessages: QueueRetryMessage[];
 }
 declare type ServiceBindingQueueMessage<Body = unknown> = {
   id: string;
@@ -1288,32 +1290,51 @@ declare interface KVNamespaceGetWithMetadataResult<Value, Metadata> {
 declare type QueueContentType = "text" | "bytes" | "json" | "v8";
 declare interface Queue<Body = unknown> {
   send(message: Body, options?: QueueSendOptions): Promise<void>;
-  sendBatch(messages: Iterable<MessageSendRequest<Body>>): Promise<void>;
+  sendBatch(
+    messages: Iterable<MessageSendRequest<Body>>,
+    options?: QueueSendBatchOptions
+  ): Promise<void>;
 }
 declare interface QueueSendOptions {
   contentType?: QueueContentType;
+  delaySeconds?: number;
+}
+declare interface QueueSendBatchOptions {
+  delaySeconds?: number;
 }
 declare interface MessageSendRequest<Body = unknown> {
   body: Body;
   contentType?: QueueContentType;
+  delaySeconds?: number;
+}
+declare interface QueueRetryBatch {
+  retry: boolean;
+  delaySeconds?: number;
+}
+declare interface QueueRetryMessage {
+  msgId: string;
+  delaySeconds?: number;
+}
+declare interface QueueRetryOptions {
+  delaySeconds?: number;
 }
 declare interface Message<Body = unknown> {
   readonly id: string;
   readonly timestamp: Date;
   readonly body: Body;
-  retry(): void;
+  retry(options?: QueueRetryOptions): void;
   ack(): void;
 }
 declare interface QueueEvent<Body = unknown> extends ExtendableEvent {
   readonly messages: readonly Message<Body>[];
   readonly queue: string;
-  retryAll(): void;
+  retryAll(options?: QueueRetryOptions): void;
   ackAll(): void;
 }
 declare interface MessageBatch<Body = unknown> {
   readonly messages: readonly Message<Body>[];
   readonly queue: string;
-  retryAll(): void;
+  retryAll(options?: QueueRetryOptions): void;
   ackAll(): void;
 }
 declare interface R2Error extends Error {
@@ -1479,7 +1500,11 @@ declare type R2Objects = {
       truncated: false;
     }
 );
-declare abstract class WorkerRpc extends Fetcher {}
+declare interface JsRpcProperty {
+  then(handler: Function, errorHandler?: Function): any;
+  catch(errorHandler: Function): any;
+  finally(onFinally: Function): any;
+}
 declare abstract class ScheduledEvent extends ExtendableEvent {
   readonly scheduledTime: number;
   readonly cron: string;
@@ -1620,6 +1645,9 @@ declare class ReadableStreamBYOBReader {
     view: T
   ): Promise<ReadableStreamReadResult<T>>;
 }
+declare interface ReadableStreamBYOBReaderReadableStreamBYOBReaderReadOptions {
+  min?: number;
+}
 declare interface ReadableStreamGetReaderOptions {
   mode: "byob";
 }
@@ -1862,30 +1890,30 @@ declare interface UnsafeTraceMetrics {
 }
 declare class URL {
   constructor(url: string | URL, base?: string | URL);
-  get origin(): string;
-  get href(): string;
-  set href(value: string);
-  get protocol(): string;
-  set protocol(value: string);
-  get username(): string;
-  set username(value: string);
-  get password(): string;
-  set password(value: string);
-  get host(): string;
-  set host(value: string);
-  get hostname(): string;
-  set hostname(value: string);
-  get port(): string;
-  set port(value: string);
-  get pathname(): string;
-  set pathname(value: string);
-  get search(): string;
-  set search(value: string);
-  get hash(): string;
-  set hash(value: string);
+  get origin(): ArrayBuffer;
+  get href(): ArrayBufferView;
+  set href(value: ArrayBufferView);
+  get protocol(): ArrayBufferView;
+  set protocol(value: ArrayBufferView);
+  get username(): ArrayBufferView;
+  set username(value: ArrayBufferView);
+  get password(): ArrayBufferView;
+  set password(value: ArrayBufferView);
+  get host(): ArrayBufferView;
+  set host(value: ArrayBufferView);
+  get hostname(): ArrayBufferView;
+  set hostname(value: ArrayBufferView);
+  get port(): ArrayBufferView;
+  set port(value: ArrayBufferView);
+  get pathname(): ArrayBufferView;
+  set pathname(value: ArrayBufferView);
+  get search(): ArrayBufferView;
+  set search(value: ArrayBufferView);
+  get hash(): ArrayBufferView;
+  set hash(value: ArrayBufferView);
   get searchParams(): URLSearchParams;
-  toJSON(): string;
-  toString(): string;
+  toJSON(): ArrayBufferView;
+  toString(): ArrayBufferView;
   static canParse(url: string, base?: string): boolean;
 }
 declare class URLSearchParams {
@@ -1895,14 +1923,14 @@ declare class URLSearchParams {
   get size(): number;
   append(name: string, value: string): void;
   delete(name: string, value?: string): void;
-  get(name: string): string | null;
-  getAll(name: string): string[];
+  get(name: string): ArrayBufferView | null;
+  getAll(name: string): ArrayBufferView[];
   has(name: string, value?: string): boolean;
   set(name: string, value: string): void;
   sort(): void;
   entries(): IterableIterator<[key: string, value: string]>;
-  keys(): IterableIterator<string>;
-  values(): IterableIterator<string>;
+  keys(): IterableIterator<ArrayBufferView>;
+  values(): IterableIterator<ArrayBufferView>;
   forEach<This = unknown>(
     callback: (
       this: This,
@@ -1916,7 +1944,11 @@ declare class URLSearchParams {
   [Symbol.iterator](): IterableIterator<[key: string, value: string]>;
 }
 declare class URLPattern {
-  constructor(input?: string | URLPatternURLPatternInit, baseURL?: string);
+  constructor(
+    input?: string | URLPatternURLPatternInit,
+    baseURL?: string,
+    patternOptions?: URLPatternURLPatternOptions
+  );
   get protocol(): string;
   get username(): string;
   get password(): string;
@@ -1957,6 +1989,9 @@ declare interface URLPatternURLPatternResult {
   search: URLPatternURLPatternComponentResult;
   hash: URLPatternURLPatternComponentResult;
 }
+declare interface URLPatternURLPatternOptions {
+  ignoreCase?: boolean;
+}
 declare class CloseEvent extends Event {
   constructor(type: string, initializer: CloseEventInit);
   /** Returns the WebSocket connection close code provided by the server. */
@@ -2133,9 +2168,9 @@ declare interface gpuGPUBuffer {
   unmap(): void;
   destroy(): void;
   mapAsync(
-    mode: number,
-    offset?: number | bigint,
-    size?: number | bigint
+    offset: number,
+    size?: number | bigint,
+    param3?: number | bigint
   ): Promise<void>;
   get size(): number | bigint;
   get usage(): number;
@@ -3580,7 +3615,10 @@ declare abstract class D1PreparedStatement {
   first<T = Record<string, unknown>>(): Promise<T | null>;
   run(): Promise<D1Response>;
   all<T = Record<string, unknown>>(): Promise<D1Result<T>>;
-  raw<T = unknown[]>(): Promise<T[]>;
+  raw<T = unknown[]>(options: {
+    columnNames: true;
+  }): Promise<[string[], ...T[]]>;
+  raw<T = unknown[]>(options?: { columnNames?: false }): Promise<T[]>;
 }
 /**
  * An email message that can be sent from a Worker.
@@ -3695,7 +3733,7 @@ declare interface Hyperdrive {
 }
 declare type Params<P extends string = any> = Record<P, string | string[]>;
 declare type EventContext<Env, P extends string, Data> = {
-  request: Request;
+  request: Request<unknown, IncomingRequestCfProperties<unknown>>;
   functionPath: string;
   waitUntil: (promise: Promise<any>) => void;
   passThroughOnException: () => void;
@@ -3714,7 +3752,7 @@ declare type PagesFunction<
   Data extends Record<string, unknown> = Record<string, unknown>
 > = (context: EventContext<Env, Params, Data>) => Response | Promise<Response>;
 declare type EventPluginContext<Env, P extends string, Data, PluginArgs> = {
-  request: Request;
+  request: Request<unknown, IncomingRequestCfProperties<unknown>>;
   functionPath: string;
   waitUntil: (promise: Promise<any>) => void;
   passThroughOnException: () => void;

package/experimental/index.ts CHANGED Viewed

@@ -310,6 +310,7 @@ export interface TestController {}
 export interface ExecutionContext {
   waitUntil(promise: Promise<any>): void;
   passThroughOnException(): void;
+  abort(reason?: any): void;
 }
 export type ExportedHandlerFetchHandler<
   Env = unknown,
@@ -383,6 +384,10 @@ export interface Performance {
   readonly timeOrigin: number;
   now(): number;
 }
+export interface AlarmInvocationInfo {
+  readonly isRetry: boolean;
+  readonly retryCount: number;
+}
 export interface DurableObject {
   fetch(request: Request): Response | Promise<Response>;
   alarm?(): void | Promise<void>;
@@ -398,7 +403,7 @@ export interface DurableObject {
   ): void | Promise<void>;
   webSocketError?(ws: WebSocket, error: unknown): void | Promise<void>;
 }
-export interface DurableObjectStub extends WorkerRpc {
+export interface DurableObjectStub extends Fetcher {
   readonly id: DurableObjectId;
   readonly name?: string;
 }
@@ -653,9 +658,9 @@ export interface SchedulerWaitOptions {
 export declare abstract class ExtendableEvent extends Event {
   waitUntil(promise: Promise<any>): void;
 }
-export declare class CustomEvent extends Event {
+export declare class CustomEvent<T = any> extends Event {
   constructor(type: string, init?: CustomEventCustomEventInit);
-  get detail(): any | undefined;
+  get detail(): T;
 }
 export interface CustomEventCustomEventInit {
   bubbles?: boolean;
@@ -1146,10 +1151,7 @@ export declare abstract class Fetcher {
     messages: ServiceBindingQueueMessage[]
   ): Promise<FetcherQueueResult>;
   scheduled(options?: FetcherScheduledOptions): Promise<FetcherScheduledResult>;
-}
-export interface FetcherPutOptions {
-  expiration?: number;
-  expirationTtl?: number;
+  getRpcMethodForTestOnly(name: string): JsRpcProperty | null;
 }
 export interface FetcherScheduledOptions {
   scheduledTime?: Date;
@@ -1161,10 +1163,10 @@ export interface FetcherScheduledResult {
 }
 export interface FetcherQueueResult {
   outcome: string;
-  retryAll: boolean;
   ackAll: boolean;
-  explicitRetries: string[];
+  retryBatch: QueueRetryBatch;
   explicitAcks: string[];
+  retryMessages: QueueRetryMessage[];
 }
 export type ServiceBindingQueueMessage<Body = unknown> = {
   id: string;
@@ -1290,32 +1292,51 @@ export interface KVNamespaceGetWithMetadataResult<Value, Metadata> {
 export type QueueContentType = "text" | "bytes" | "json" | "v8";
 export interface Queue<Body = unknown> {
   send(message: Body, options?: QueueSendOptions): Promise<void>;
-  sendBatch(messages: Iterable<MessageSendRequest<Body>>): Promise<void>;
+  sendBatch(
+    messages: Iterable<MessageSendRequest<Body>>,
+    options?: QueueSendBatchOptions
+  ): Promise<void>;
 }
 export interface QueueSendOptions {
   contentType?: QueueContentType;
+  delaySeconds?: number;
+}
+export interface QueueSendBatchOptions {
+  delaySeconds?: number;
 }
 export interface MessageSendRequest<Body = unknown> {
   body: Body;
   contentType?: QueueContentType;
+  delaySeconds?: number;
+}
+export interface QueueRetryBatch {
+  retry: boolean;
+  delaySeconds?: number;
+}
+export interface QueueRetryMessage {
+  msgId: string;
+  delaySeconds?: number;
+}
+export interface QueueRetryOptions {
+  delaySeconds?: number;
 }
 export interface Message<Body = unknown> {
   readonly id: string;
   readonly timestamp: Date;
   readonly body: Body;
-  retry(): void;
+  retry(options?: QueueRetryOptions): void;
   ack(): void;
 }
 export interface QueueEvent<Body = unknown> extends ExtendableEvent {
   readonly messages: readonly Message<Body>[];
   readonly queue: string;
-  retryAll(): void;
+  retryAll(options?: QueueRetryOptions): void;
   ackAll(): void;
 }
 export interface MessageBatch<Body = unknown> {
   readonly messages: readonly Message<Body>[];
   readonly queue: string;
-  retryAll(): void;
+  retryAll(options?: QueueRetryOptions): void;
   ackAll(): void;
 }
 export interface R2Error extends Error {
@@ -1481,7 +1502,11 @@ export type R2Objects = {
       truncated: false;
     }
 );
-export declare abstract class WorkerRpc extends Fetcher {}
+export interface JsRpcProperty {
+  then(handler: Function, errorHandler?: Function): any;
+  catch(errorHandler: Function): any;
+  finally(onFinally: Function): any;
+}
 export declare abstract class ScheduledEvent extends ExtendableEvent {
   readonly scheduledTime: number;
   readonly cron: string;
@@ -1622,6 +1647,9 @@ export declare class ReadableStreamBYOBReader {
     view: T
   ): Promise<ReadableStreamReadResult<T>>;
 }
+export interface ReadableStreamBYOBReaderReadableStreamBYOBReaderReadOptions {
+  min?: number;
+}
 export interface ReadableStreamGetReaderOptions {
   mode: "byob";
 }
@@ -1867,30 +1895,30 @@ export interface UnsafeTraceMetrics {
 }
 export declare class URL {
   constructor(url: string | URL, base?: string | URL);
-  get origin(): string;
-  get href(): string;
-  set href(value: string);
-  get protocol(): string;
-  set protocol(value: string);
-  get username(): string;
-  set username(value: string);
-  get password(): string;
-  set password(value: string);
-  get host(): string;
-  set host(value: string);
-  get hostname(): string;
-  set hostname(value: string);
-  get port(): string;
-  set port(value: string);
-  get pathname(): string;
-  set pathname(value: string);
-  get search(): string;
-  set search(value: string);
-  get hash(): string;
-  set hash(value: string);
+  get origin(): ArrayBuffer;
+  get href(): ArrayBufferView;
+  set href(value: ArrayBufferView);
+  get protocol(): ArrayBufferView;
+  set protocol(value: ArrayBufferView);
+  get username(): ArrayBufferView;
+  set username(value: ArrayBufferView);
+  get password(): ArrayBufferView;
+  set password(value: ArrayBufferView);
+  get host(): ArrayBufferView;
+  set host(value: ArrayBufferView);
+  get hostname(): ArrayBufferView;
+  set hostname(value: ArrayBufferView);
+  get port(): ArrayBufferView;
+  set port(value: ArrayBufferView);
+  get pathname(): ArrayBufferView;
+  set pathname(value: ArrayBufferView);
+  get search(): ArrayBufferView;
+  set search(value: ArrayBufferView);
+  get hash(): ArrayBufferView;
+  set hash(value: ArrayBufferView);
   get searchParams(): URLSearchParams;
-  toJSON(): string;
-  toString(): string;
+  toJSON(): ArrayBufferView;
+  toString(): ArrayBufferView;
   static canParse(url: string, base?: string): boolean;
 }
 export declare class URLSearchParams {
@@ -1900,14 +1928,14 @@ export declare class URLSearchParams {
   get size(): number;
   append(name: string, value: string): void;
   delete(name: string, value?: string): void;
-  get(name: string): string | null;
-  getAll(name: string): string[];
+  get(name: string): ArrayBufferView | null;
+  getAll(name: string): ArrayBufferView[];
   has(name: string, value?: string): boolean;
   set(name: string, value: string): void;
   sort(): void;
   entries(): IterableIterator<[key: string, value: string]>;
-  keys(): IterableIterator<string>;
-  values(): IterableIterator<string>;
+  keys(): IterableIterator<ArrayBufferView>;
+  values(): IterableIterator<ArrayBufferView>;
   forEach<This = unknown>(
     callback: (
       this: This,
@@ -1921,7 +1949,11 @@ export declare class URLSearchParams {
   [Symbol.iterator](): IterableIterator<[key: string, value: string]>;
 }
 export declare class URLPattern {
-  constructor(input?: string | URLPatternURLPatternInit, baseURL?: string);
+  constructor(
+    input?: string | URLPatternURLPatternInit,
+    baseURL?: string,
+    patternOptions?: URLPatternURLPatternOptions
+  );
   get protocol(): string;
   get username(): string;
   get password(): string;
@@ -1962,6 +1994,9 @@ export interface URLPatternURLPatternResult {
   search: URLPatternURLPatternComponentResult;
   hash: URLPatternURLPatternComponentResult;
 }
+export interface URLPatternURLPatternOptions {
+  ignoreCase?: boolean;
+}
 export declare class CloseEvent extends Event {
   constructor(type: string, initializer: CloseEventInit);
   /** Returns the WebSocket connection close code provided by the server. */
@@ -2138,9 +2173,9 @@ export interface gpuGPUBuffer {
   unmap(): void;
   destroy(): void;
   mapAsync(
-    mode: number,
-    offset?: number | bigint,
-    size?: number | bigint
+    offset: number,
+    size?: number | bigint,
+    param3?: number | bigint
   ): Promise<void>;
   get size(): number | bigint;
   get usage(): number;
@@ -3585,7 +3620,10 @@ export declare abstract class D1PreparedStatement {
   first<T = Record<string, unknown>>(): Promise<T | null>;
   run(): Promise<D1Response>;
   all<T = Record<string, unknown>>(): Promise<D1Result<T>>;
-  raw<T = unknown[]>(): Promise<T[]>;
+  raw<T = unknown[]>(options: {
+    columnNames: true;
+  }): Promise<[string[], ...T[]]>;
+  raw<T = unknown[]>(options?: { columnNames?: false }): Promise<T[]>;
 }
 /**
  * An email message that can be sent from a Worker.
@@ -3693,7 +3731,7 @@ export interface Hyperdrive {
 }
 export type Params<P extends string = any> = Record<P, string | string[]>;
 export type EventContext<Env, P extends string, Data> = {
-  request: Request;
+  request: Request<unknown, IncomingRequestCfProperties<unknown>>;
   functionPath: string;
   waitUntil: (promise: Promise<any>) => void;
   passThroughOnException: () => void;
@@ -3712,7 +3750,7 @@ export type PagesFunction<
   Data extends Record<string, unknown> = Record<string, unknown>
 > = (context: EventContext<Env, Params, Data>) => Response | Promise<Response>;
 export type EventPluginContext<Env, P extends string, Data, PluginArgs> = {
-  request: Request;
+  request: Request<unknown, IncomingRequestCfProperties<unknown>>;
   functionPath: string;
   waitUntil: (promise: Promise<any>) => void;
   passThroughOnException: () => void;