@cloudflare/workers-types 3.0.0 → 3.1.0

package/index.d.ts

@@ -1,3 +1,6 @@
+// This file is auto-generated. DO NOT MODIFY.
+// Please refer to the Auto-Generation section of the README.md.
+
 declare class AbortController {
   constructor();
   readonly signal: AbortSignal;
@@ -100,7 +103,13 @@ declare abstract class Body {
   blob(): Promise<Blob>;
 }
 
-declare type BodyInitializer = ReadableStream | string | ArrayBuffer | Blob | URLSearchParams | FormData;
+declare type BodyInit = ReadableStream | string | ArrayBuffer | Blob | URLSearchParams | FormData;
+
+/**
+ * Back compat for code migrating to older definitions.
+ * @deprecated Use BodyInit instead.
+ */
+declare type BodyInitializer = BodyInit;
 
 declare abstract class Cache {
   delete(request: Request | string, options?: CacheQueryOptions): Promise<boolean>;
@@ -117,24 +126,36 @@ declare abstract class CacheStorage {
   readonly default: Cache;
 }
 
-interface CfRequestInitializerDict extends Omit<RequestInitializerDict, "cf"> {
+interface CfRequestInit extends Omit<RequestInit, "cf"> {
   cf?: RequestInitCfProperties;
 }
 
+/**
+ * Back compat support with older types.
+ * @deprecated Use CfRequestInit instead.
+ */
+declare type CfRequestInitializerDict = CfRequestInit;
+
 declare class CloseEvent extends Event {
-  constructor(type: string, initializer: CloseEventInitializer);
+  constructor(type: string, initializer: CloseEventInit);
   readonly code: number;
   readonly reason: string;
   readonly wasClean: boolean;
 }
 
-interface CloseEventInitializer {
+interface CloseEventInit {
   code?: number;
   reason?: string;
   wasClean?: boolean;
 }
 
-declare abstract class Comment {
+/**
+ * Back compat for code migrating from older definitions.
+ * @deprecated Use CloseEventInit instead.
+ */
+declare type CloseEventInitializer = CloseEventInit;
+
+interface Comment {
   text: string;
   readonly removed: boolean;
   before(content: Content, options?: ContentOptions): Comment;
@@ -245,13 +266,13 @@ declare class DOMException extends Error {
   static readonly DATA_CLONE_ERR: number;
 }
 
-declare abstract class Doctype {
+interface Doctype {
   readonly name: string | null;
   readonly publicId: string | null;
   readonly systemId: string | null;
 }
 
-declare abstract class DocumentEnd {
+interface DocumentEnd {
   append(content: Content, options?: ContentOptions): DocumentEnd;
 }
 
@@ -259,13 +280,13 @@ interface DurableObject {
   fetch(request: Request): Promise<Response>;
 }
 
-declare abstract class DurableObjectId {
+interface DurableObjectId {
   toString(): string;
   equals(other: DurableObjectId): boolean;
   readonly name?: string;
 }
 
-declare abstract class DurableObjectNamespace {
+interface DurableObjectNamespace {
   newUniqueId(options?: DurableObjectNamespaceNewUniqueIdOptions): DurableObjectId;
   idFromName(name: string): DurableObjectId;
   idFromString(id: string): DurableObjectId;
@@ -276,14 +297,14 @@ interface DurableObjectNamespaceNewUniqueIdOptions {
   jurisdiction?: string;
 }
 
-declare abstract class DurableObjectState {
-  waitUntil(promise: Promise<void>): void;
+interface DurableObjectState {
+  waitUntil(promise: Promise<any>): void;
   readonly id: DurableObjectId | string;
-  readonly storage?: DurableObjectStorage;
+  readonly storage: DurableObjectStorage;
   blockConcurrencyWhile<T>(callback: () => Promise<T>): Promise<T>;
 }
 
-declare abstract class DurableObjectStorage {
+interface DurableObjectStorage {
   get<T = unknown>(key: string, options?: DurableObjectStorageOperationsGetOptions): Promise<T | undefined>;
   get<T = unknown>(keys: string[], options?: DurableObjectStorageOperationsGetOptions): Promise<Map<string, T>>;
   list<T = unknown>(options?: DurableObjectStorageOperationsListOptions): Promise<Map<string, T>>;
@@ -316,12 +337,12 @@ interface DurableObjectStorageOperationsPutOptions {
   noCache?: boolean;
 }
 
-declare abstract class DurableObjectStub extends Fetcher {
+interface DurableObjectStub extends Fetcher {
   readonly id: DurableObjectId;
   readonly name?: string;
 }
 
-declare abstract class DurableObjectTransaction {
+interface DurableObjectTransaction {
   get<T = unknown>(key: string, options?: DurableObjectStorageOperationsGetOptions): Promise<T>;
   get<T = unknown>(keys: string[], options?: DurableObjectStorageOperationsGetOptions): Promise<Map<string, T>>;
   list<T = unknown>(options?: DurableObjectStorageOperationsListOptions): Promise<Map<string, T>>;
@@ -332,7 +353,7 @@ declare abstract class DurableObjectTransaction {
   rollback(): void;
 }
 
-declare abstract class Element {
+interface Element {
   tagName: string;
   readonly attributes: IterableIterator<string[]>;
   readonly removed: boolean;
@@ -400,14 +421,15 @@ interface EventTargetAddEventListenerOptions {
   capture?: boolean;
   passive?: boolean;
   once?: boolean;
+  signal?: AbortSignal;
 }
 
 interface EventTargetEventListenerOptions {
   capture?: boolean;
 }
 
-declare abstract class ExecutionContext {
-  waitUntil(promise: Promise<void>): void;
+interface ExecutionContext {
+  waitUntil(promise: Promise<any>): void;
   passThroughOnException(): void;
 }
 
@@ -420,16 +442,15 @@ declare type ExportedHandlerFetchHandler<Env = unknown> = (request: Request, env
 
 declare type ExportedHandlerScheduledHandler<Env = unknown> = (controller: ScheduledController, env: Env, ctx: ExecutionContext) => void | Promise<void>;
 
-declare class FetchEvent extends Event {
-  constructor(type: string);
+declare abstract class FetchEvent extends Event {
   readonly request: Request;
   respondWith(promise: Response | Promise<Response>): void;
   passThroughOnException(): void;
-  waitUntil(promise: Promise<void>): void;
+  waitUntil(promise: Promise<any>): void;
 }
 
 declare abstract class Fetcher {
-  fetch(requestOrUrl: Request | string, requestInit?: RequestInitializerDict | Request): Promise<Response>;
+  fetch(requestOrUrl: Request | string, requestInit?: RequestInit | Request): Promise<Response>;
 }
 
 declare class File extends Blob {
@@ -485,7 +506,7 @@ interface HTMLRewriterElementContentHandlers {
 }
 
 declare class Headers {
-  constructor(init?: HeadersInitializer);
+  constructor(init?: HeadersInit);
   get(name: string): string | null;
   getAll(name: string): string[];
   has(name: string): boolean;
@@ -499,13 +520,19 @@ declare class Headers {
   [Symbol.iterator](): IterableIterator<[key: string, value: string]>;
 }
 
-declare type HeadersInitializer = Headers | Record<string, string> | ([key: string, value: string])[];
+declare type HeadersInit = Headers | Record<string, string> | ([key: string, value: string])[];
+
+/**
+ * Back compat for code migrating to older definitions.
+ * @deprecated Use HeadersInit instead.
+ */
+declare type HeadersInitializer = HeadersInit;
 
 /**
  * In addition to the properties on the standard Request object,
  * the cf object contains extra information about the request provided
  * by Cloudflare's edge.
- *
+ * 
  * Note: Currently, settings in the cf object cannot be accessed in the
  * playground.
  */
@@ -514,6 +541,11 @@ interface IncomingRequestCfProperties {
    * (e.g. 395747)
    */
   asn: number;
+  /**
+   * The organisation which owns the ASN of the incoming request.
+   * (e.g. Google Cloud)
+   */
+  asOrganization: string;
   botManagement?: IncomingRequestCfPropertiesBotManagement;
   city?: string;
   clientTcpRtt: number;
@@ -590,7 +622,7 @@ interface IncomingRequestCfPropertiesTLSClientAuth {
  * Workers KV is a global, low-latency, key-value data store. It supports exceptionally high read volumes with low-latency,
  * making it possible to build highly dynamic APIs and websites which respond as quickly as a cached static file would.
  */
-declare abstract class KVNamespace {
+interface KVNamespace {
   get(key: string, options?: Partial<KVNamespaceGetOptions<undefined>>): Promise<string | null>;
   get(key: string, type: "text"): Promise<string | null>;
   get<ExpectedValue = unknown>(key: string, type: "json"): Promise<ExpectedValue | null>;
@@ -657,52 +689,98 @@ interface KVNamespacePutOptions {
 }
 
 declare class MessageEvent extends Event {
-  constructor(type: string, initializer: MessageEventInitializer);
+  constructor(type: string, initializer: MessageEventInit);
   readonly data: ArrayBuffer | string;
 }
 
-interface MessageEventInitializer {
+interface MessageEventInit {
   data: ArrayBuffer | string;
 }
 
+/**
+ * Back compat for code migrating from older definitions.
+ * @deprecated Use MessageEventInit instead.
+ */
+declare type MessageEventInitializer = MessageEventInit;
+
+/**
+ * Transitionary name.
+ * @deprecated Use StreamPipeOptions
+ */
+interface PipeToOptions {
+  preventClose?: boolean;
+  preventAbort?: boolean;
+  preventCancel?: boolean;
+}
+
+declare abstract class PromiseRejectionEvent extends Event {
+  readonly promise: Promise<any>;
+  readonly reason: any;
+}
+
+interface ReadResult {
+  value?: any;
+  done: boolean;
+}
+
 declare abstract class ReadableStream {
   readonly locked: boolean;
   cancel(reason?: any): Promise<void>;
-  getReader(options?: ReadableStreamGetReaderOptions): ReadableStreamReader;
-  pipeThrough(transform: ReadableStreamTransform, options?: ReadableStreamPipeToOptions): ReadableStream;
-  pipeTo(destination: WritableStream, options?: ReadableStreamPipeToOptions): Promise<void>;
+  getReader(options: ReadableStreamGetReaderOptions): ReadableStreamBYOBReader;
+  getReader(): ReadableStreamDefaultReader;
+  pipeThrough(transform: ReadableStreamTransform, options?: PipeToOptions): ReadableStream;
+  pipeTo(destination: WritableStream, options?: PipeToOptions): Promise<void>;
   tee(): [ReadableStream, ReadableStream];
 }
 
-interface ReadableStreamGetReaderOptions {
-  mode?: string;
-}
-
-interface ReadableStreamPipeToOptions {
-  preventClose?: boolean;
-  preventAbort?: boolean;
-  preventCancel?: boolean;
+declare class ReadableStreamBYOBReader {
+  constructor(stream: ReadableStream);
+  readonly closed: Promise<void>;
+  cancel(reason?: any): Promise<void>;
+  read<T extends ArrayBufferView>(view: T): Promise<ReadableStreamReadResult<T>>;
+  releaseLock(): void;
+  readAtLeast(minBytes: number, view: Uint8Array): Promise<ReadableStreamReadResult<Uint8Array>>;
 }
 
-declare abstract class ReadableStreamReader {
+declare class ReadableStreamDefaultReader {
+  constructor(stream: ReadableStream);
   readonly closed: Promise<void>;
   cancel(reason?: any): Promise<void>;
-  read(byobBuffer?: ArrayBufferView): Promise<ReadableStreamReaderReadResult>;
+  read(): Promise<ReadableStreamReadResult<any>>;
   releaseLock(): void;
 }
 
-interface ReadableStreamReaderReadResult {
-  value?: any;
-  done: boolean;
+interface ReadableStreamGetReaderOptions {
+  mode: string;
 }
 
+/**
+ * Back-compat alias.
+ * @deprecated Use StreamPipeOptions
+ */
+declare type ReadableStreamPipeToOptions = PipeToOptions;
+
+declare type ReadableStreamReadResult<T = any> = { done: true; value: undefined; } | { done: false; value: T; };
+
+/**
+ * Back-compat alias.
+ * @deprecated Use ReadableStreamBYOBReader
+ */
+declare type ReadableStreamReadableStreamBYOBReader = ReadableStreamBYOBReader;
+
+/**
+ * Back-compat alias.
+ * @deprecated Use ReadableStreamDefaultReader
+ */
+declare type ReadableStreamReadableStreamDefaultReader = ReadableStreamDefaultReader;
+
 interface ReadableStreamTransform {
   writable: WritableStream;
   readable: ReadableStream;
 }
 
 declare class Request extends Body {
-  constructor(input: Request | string, init?: RequestInitializerDict | Request);
+  constructor(input: Request | string, init?: RequestInit | Request);
   clone(): Request;
   readonly method: string;
   readonly url: string;
@@ -713,12 +791,33 @@ declare class Request extends Body {
   readonly cf?: IncomingRequestCfProperties;
 }
 
+interface RequestInit {
+  method?: string;
+  headers?: HeadersInit;
+  body?: BodyInit | null;
+  redirect?: string;
+  fetcher?: Fetcher | null;
+  /**
+   * cf is a union of these two types because there are multiple
+   * scenarios in which it might be one or the other.
+   * 
+   * IncomingRequestCfProperties is required to allow
+   *   new Request(someUrl, event.request)
+   * 
+   * RequestInitCfProperties is required to allow
+   *   new Request(event.request, {cf: { ... } })
+   *   fetch(someUrl, {cf: { ... } })
+   */
+  cf?: IncomingRequestCfProperties | RequestInitCfProperties;
+  signal?: AbortSignal | null;
+}
+
 /**
  * In addition to the properties you can set in the RequestInit dict
  * that you pass as an argument to the Request constructor, you can
  * set certain properties of a `cf` object to control how Cloudflare
  * features are applied to that new Request.
- *
+ * 
  * Note: Currently, these properties cannot be tested in the
  * playground.
  */
@@ -729,7 +828,7 @@ interface RequestInitCfProperties {
    * "the same" for caching purposes. If a request has the same cache key
    * as some previous request, then we can serve the same cached response for
    * both. (e.g. 'some-key')
-   *
+   * 
    * Only available for Enterprise customers.
    */
   cacheKey?: string;
@@ -751,7 +850,7 @@ interface RequestInitCfProperties {
    * Redirects the request to an alternate origin server. You can use this,
    * for example, to implement load balancing across several origins.
    * (e.g.us-east.example.com)
-   *
+   * 
    * Note - For security reasons, the hostname set in resolveOverride must
    * be proxied on the same Cloudflare zone of the incoming request.
    * Otherwise, the setting is ignored. CNAME hosts are allowed, so to
@@ -833,9 +932,9 @@ interface RequestInitCfPropertiesImageDraw extends BasicImageTransformations {
    * positions left side of the overlay 10 pixels from the left edge of the
    * image it's drawn over. bottom: 0 aligns bottom of the overlay with bottom
    * of the background image.
-   *
+   * 
    * Setting both left & right, or both top & bottom is an error.
-   *
+   * 
    * If no position is specified, the image will be centered.
    */
   top?: number;
@@ -850,29 +949,14 @@ interface RequestInitCfPropertiesImageMinify {
   html?: boolean;
 }
 
-interface RequestInitializerDict {
-  method?: string;
-  headers?: HeadersInitializer;
-  body?: BodyInitializer | null;
-  redirect?: string;
-  fetcher?: Fetcher | null;
-  /**
-   * cf is a union of these two types because there are multiple
-   * scenarios in which it might be one or the other.
-   *
-   * IncomingRequestCfProperties is required to allow
-   *   new Request(someUrl, event.request)
-   *
-   * RequestInitCfProperties is required to allow
-   *   new Request(event.request, {cf: { ... } })
-   *   fetch(someUrl, {cf: { ... } })
-   */
-  cf?: IncomingRequestCfProperties | RequestInitCfProperties;
-  signal?: AbortSignal | null;
-}
+/**
+ * Back compat for code migrating from older definitions.
+ * @deprecated Use RequestInit instead.
+ */
+declare type RequestInitializerDict = RequestInit;
 
 declare class Response extends Body {
-  constructor(bodyInit?: BodyInitializer | null, maybeInit?: ResponseInitializerDict | Response);
+  constructor(bodyInit?: BodyInit | null, maybeInit?: ResponseInit | Response);
   static redirect(url: string, status?: number): Response;
   clone(): Response;
   readonly status: number;
@@ -885,33 +969,35 @@ declare class Response extends Body {
   readonly cf?: Object;
 }
 
-interface ResponseInitializerDict {
+interface ResponseInit {
   status?: number;
   statusText?: string;
-  headers?: HeadersInitializer;
+  headers?: HeadersInit;
   cf?: Object;
   webSocket?: WebSocket | null;
   encodeBody?: string;
 }
 
-declare abstract class ScheduledController {
+/**
+ * Back compat for code migrating from older definitions.
+ * @deprecated Use ResponseInit instead.
+ */
+declare type ResponseInitializerDict = ResponseInit;
+
+interface ScheduledController {
   readonly scheduledTime: number;
   readonly cron: string;
   noRetry(): void;
 }
 
-declare class ScheduledEvent extends Event {
-  constructor(type: string);
+declare abstract class ScheduledEvent extends Event {
   readonly scheduledTime: number;
   readonly cron: string;
   noRetry(): void;
-  waitUntil(promise: Promise<void>): void;
+  waitUntil(promise: Promise<any>): void;
 }
 
-declare class ServiceWorkerGlobalScope extends WorkerGlobalScope {
-  constructor();
-  static readonly DOMException: typeof DOMException;
-  static readonly WorkerGlobalScope: typeof WorkerGlobalScope;
+interface ServiceWorkerGlobalScope extends WorkerGlobalScope {
   btoa(data: string): string;
   atob(data: string): string;
   setTimeout<Args extends any[]>(callback: (...args: Args) => void, msDelay?: number, ...args: Args): number;
@@ -919,46 +1005,18 @@ declare class ServiceWorkerGlobalScope extends WorkerGlobalScope {
   setInterval<Args extends any[]>(callback: (...args: Args) => void, msDelay?: number, ...args: Args): number;
   clearInterval(timeoutId: number | null): void;
   queueMicrotask(task: Function): void;
-  fetch(request: Request | string, requestInitr?: RequestInitializerDict | Request): Promise<Response>;
+  fetch(request: Request | string, requestInitr?: RequestInit | Request): Promise<Response>;
   readonly self: ServiceWorkerGlobalScope;
   readonly crypto: Crypto;
   readonly caches: CacheStorage;
-  static readonly Event: typeof Event;
-  static readonly FetchEvent: typeof FetchEvent;
-  static readonly ScheduledEvent: typeof ScheduledEvent;
-  static readonly MessageEvent: typeof MessageEvent;
-  static readonly CloseEvent: typeof CloseEvent;
-  static readonly ReadableStream: typeof ReadableStream;
-  static readonly WritableStream: typeof WritableStream;
-  static readonly TransformStream: typeof TransformStream;
-  static readonly Headers: typeof Headers;
-  static readonly Body: typeof Body;
-  static readonly Request: typeof Request;
-  static readonly Response: typeof Response;
-  static readonly WebSocket: typeof WebSocket;
-  static readonly WebSocketPair: typeof WebSocketPair;
-  static readonly AbortController: typeof AbortController;
-  static readonly AbortSignal: typeof AbortSignal;
-  static readonly TextDecoder: typeof TextDecoder;
-  static readonly TextEncoder: typeof TextEncoder;
-  static readonly URL: typeof URL;
-  static readonly URLSearchParams: typeof URLSearchParams;
-  static readonly Blob: typeof Blob;
-  static readonly File: typeof File;
-  static readonly FormData: typeof FormData;
-  static readonly Crypto: typeof Crypto;
-  static readonly SubtleCrypto: typeof SubtleCrypto;
-  static readonly CryptoKey: typeof CryptoKey;
-  static readonly CacheStorage: typeof CacheStorage;
-  static readonly Cache: typeof Cache;
-  static readonly FixedLengthStream: typeof FixedLengthStream;
-  static readonly HTMLRewriter: typeof HTMLRewriter;
   readonly console: Console;
 }
 
+declare type StreamPipeOptions = PipeToOptions;
+
 interface StreamQueuingStrategy {
-  highWaterMark: number;
-  size(arg1: any): number;
+  highWaterMark?: number;
+  size(chunk: ArrayBuffer): number;
 }
 
 declare abstract class SubtleCrypto {
@@ -1050,7 +1108,7 @@ interface SubtleCryptoSignAlgorithm {
   saltLength?: number;
 }
 
-declare abstract class Text {
+interface Text {
   readonly text: string;
   readonly lastInTextNode: boolean;
   readonly removed: boolean;
@@ -1114,7 +1172,7 @@ declare class URL {
 }
 
 declare class URLSearchParams {
-  constructor(init?: URLSearchParamsInitializer);
+  constructor(init?: URLSearchParamsInit);
   append(name: string, value: string): void;
   delete(name: string): void;
   get(name: string): string | null;
@@ -1130,7 +1188,15 @@ declare class URLSearchParams {
   toString(): string;
 }
 
-declare type URLSearchParamsInitializer = URLSearchParams | string | Record<string, string> | ([key: string, value: string])[];
+declare type URLSearchParamsInit = URLSearchParams | string | Record<string, string> | ([key: string, value: string])[];
+
+/**
+ * Back compat for code migrating to older definitions.
+ * This technically isn't part of a standard either way, but the naming
+ * is more consistent.
+ * @deprecated Use URLSearchParamsInit instead.
+ */
+declare type URLSearchParamsInitializer = URLSearchParamsInit;
 
 declare abstract class WebSocket extends EventTarget<WebSocketEventMap> {
   accept(): void;
@@ -1142,20 +1208,21 @@ declare type WebSocketEventMap = { close: CloseEvent; message: MessageEvent; };
 
 declare const WebSocketPair: { new(): { 0: WebSocket; 1: WebSocket; }; };
 
-declare class WorkerGlobalScope extends EventTarget<WorkerGlobalScopeEventMap> {
-  constructor();
-  static readonly EventTarget: typeof EventTarget;
+declare abstract class WorkerGlobalScope extends EventTarget<WorkerGlobalScopeEventMap> {
+
 }
 
-declare type WorkerGlobalScopeEventMap = { fetch: FetchEvent; scheduled: ScheduledEvent; };
+declare type WorkerGlobalScopeEventMap = { fetch: FetchEvent; scheduled: ScheduledEvent; unhandledrejection: PromiseRejectionEvent; rejectionhandled: PromiseRejectionEvent; };
 
 declare abstract class WritableStream {
   readonly locked: boolean;
   abort(reason: any): Promise<void>;
-  getWriter(): WritableStreamWriter;
+  close(): Promise<void>;
+  getWriter(): WritableStreamDefaultWriter;
 }
 
-declare abstract class WritableStreamWriter {
+declare class WritableStreamDefaultWriter {
+  constructor(stream: WritableStream);
   readonly closed: Promise<void>;
   readonly desiredSize: number | null;
   abort(reason: any): Promise<void>;
@@ -1164,6 +1231,12 @@ declare abstract class WritableStreamWriter {
   releaseLock(): void;
 }
 
+/**
+ * Back-compat alias.
+ * @deprecated Use WritableStreamDefaultWriter
+ */
+declare type WritableStreamWritableStreamDefaultWriter = WritableStreamDefaultWriter;
+
 declare function addEventListener<Type extends keyof WorkerGlobalScopeEventMap>(type: Type, handler: EventListenerOrEventListenerObject<WorkerGlobalScopeEventMap[Type]>, options?: EventTargetAddEventListenerOptions | boolean): void;
 
 declare function atob(data: string): string;
@@ -1182,7 +1255,7 @@ declare const crypto: Crypto;
 
 declare function dispatchEvent(event: WorkerGlobalScopeEventMap[keyof WorkerGlobalScopeEventMap]): boolean;
 
-declare function fetch(request: Request | string, requestInitr?: RequestInitializerDict | Request): Promise<Response>;
+declare function fetch(request: Request | string, requestInitr?: RequestInit | Request): Promise<Response>;
 
 declare function queueMicrotask(task: Function): void;
 
@@ -1193,3 +1266,4 @@ declare const self: ServiceWorkerGlobalScope;
 declare function setInterval<Args extends any[]>(callback: (...args: Args) => void, msDelay?: number, ...args: Args): number;
 
 declare function setTimeout<Args extends any[]>(callback: (...args: Args) => void, msDelay?: number, ...args: Args): number;
+

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@cloudflare/workers-types",
-  "version": "3.0.0",
+  "version": "3.1.0",
   "description": "TypeScript typings for Cloudflare Workers",
   "repository": {
     "type": "git",

package/CHANGELOG.md

@@ -1,282 +0,0 @@
-# Changelog
-
-## 3.0.0
-
-### Features
-
-- **Types are automatically generated from the runtime - [@mrbbot], [pull/112]**
-  Types now match exactly what's defined in the runtime source code, meaning `webworker` should be removed from users' `tsconfig.json`s
-
-  [@mrbbot]: https://github.com/mrbbot
-  [pull/112]: https://github.com/cloudflare/workers-types/pull/112
-
-## 2.2.2
-
-### Features
-
-- **Add KVNamespace.get options parameter, with cacheTtl - [@bretthoerner], [pull/87]**
-
-### Bugfixes
-
-- **fix DurableObjectStorage transaction method signature - [@sbfaulkner], [pull/89]**
-
-## 2.1.0
-
-### Features
-
-- **Add types for Durable Objects - [@mathew-cf], [pull/63], [issue/64]**
-  Types for [Durable Objects Beta](https://developers.cloudflare.com/workers/runtime-apis/durable-objects), subject to change.
-
-  [@mathew-cf]: https://github.com/mathew-cf
-  [pull/63]: https://github.com/cloudflare/workers-types/pull/63
-  [issue/64]: https://github.com/cloudflare/workers-types/issues/64
-
-- **Add ScheduledEvent - [@qwtel], [pull/61]**
-  Types for [Scheduled Events](https://developers.cloudflare.com/workers/runtime-apis/scheduled-event)
-
-  [@qwtel]: https://github.com/qwtel
-  [pull/61]: https://github.com/cloudflare/workers-types/pull/61
-
-- **Add AVIF Format for Image Resizing - [@GregBrimble], [pull/59]**
-
-  [@GregBrimble]: https://github.com/GregBrimble
-  [pull/59]: https://github.com/cloudflare/workers-types/pull/59
-
-- **Add metadata typings for KV - [@GregBrimble], [pull/54]**
-  Adds the [new metadata](https://developers.cloudflare.com/workers/runtime-apis/kv#metadata) types to the getWithMetadata, put and list methods on a KV namespace.
-
-  [@GregBrimble]: https://github.com/GregBrimble
-  [pull/54]: https://github.com/cloudflare/workers-types/pull/54
-
-- **Complete Image Resizing properties - [@GregBrimble], [pull/50]**
-  Adds missing options for the Image Resizing API.
-
-  [@GregBrimble]: https://github.com/GregBrimble
-  [pull/50]: https://github.com/cloudflare/workers-types/pull/50
-
-- **Add API for async handlers and end handler - [@ObsidianMinor], [pull/48]**
-  Types for [HTML Rewriter](https://developers.cloudflare.com/workers/runtime-apis/html-rewriter#end) end of document append method
-
-  [@ObsidianMinor]: https://github.com/ObsidianMinor
-  [pull/48]: https://github.com/cloudflare/workers-types/pull/48
-
-### Bugfixes
-
-- **Make Element.attributes iterable - [@jdanyow], [pull/47]**
-
-  Fixing a bug in the type definitions that prevents writing valid code like this:
-
-  ```typescript
-  rewriter.on('bla', {
-    element: element => {
-      for (const [name, value] of element.attributes) {
-  ```
-
-  [@jdanyow]: https://github.com/jdanyow
-  [pull/47]: https://github.com/cloudflare/workers-types/pull/47
-
-### Maintenance
-
-- **Update README.md instructions to avoid typescript error - [@jeremistadler], [pull/60]**
-  Add empty export to bindings.d.ts example to avoid an typescript error
-
-  [@jeremistadler]: https://github.com/jeremistadler
-  [pull/60]: https://github.com/cloudflare/workers-types/pull/60
-
-- **Add a GitHub action to lint the Markdown - [@jbampton],[pull/51]**
-
-  [@jbampton]: https://github.com/jbampton
-  [pull/51]: https://github.com/cloudflare/workers-types/pull/51
-
-- **Fix spelling - [@jbampton],[pull/50]**
-
-  [@jbampton]: https://github.com/jbampton
-  [pull/50]: https://github.com/cloudflare/workers-types/pull/50
-
-- **Add CODEOWNERS - [@ispivey], [pull/49]**
-  This will ensure we have default reviewers.
-
-  [@ispivey]: https://github.com/ispivey
-  [pull/48]: https://github.com/cloudflare/workers-types/pull/48
-
-- **Add prettier and typescript as devDependencies - [@1000hz], [pull/46]**
-  Automated formatting via prettier
-
-  [@1000hz]: https://github.com/1000hz
-  [pull/46]: https://github.com/cloudflare/workers-types/pull/46
-
-## ⌨️ 2.0.0
-
-### Breaking Changes
-
-- **Types now only provided via automatic type inclusion, rather than explicit import - [@jdanyow], [issue/33], [pull/34]**
-
-  Users should no longer use an empty import to include `workers-types`, which used to be the recommendation in the README.
-
-  Remove this from your code:
-
-  ```typescript
-  import {} from '@cloudflare/workers-types'
-  ```
-
-  And instead include the types explicitly in your TypeScript configuration compiler options:
-
-  ```json
-  {
-    "compilerOptions": {
-      "types": ["@cloudflare/workers-types"]
-    }
-  }
-  ```
-
-  [@jdanyow]: https://github.com/jdanyow
-  [pull/34]: https://github.com/cloudflare/workers-types/pull/34
-  [issue/33]: https://github.com/cloudflare/workers-types/issues/33
-
-### Features
-
-- **Add Cache behavior modifiers to outbound Requests - [@trjstewart], [issue/22], [pull/17]**
-
-  When constructing a request, you can now include the following cache-manipulating properties in the initializer dictionary:
-
-  ```typescript
-  // Force response to be cached for 300 seconds.
-  fetch(event.request, { cf: { cacheTtl: 300 } })
-
-  // Force response to be cached for 86400 seconds for 200 status codes, 1 second for 404, and do not cache 500 errors
-  fetch(request, { cf: { cacheTtlByStatus: { '200-299': 86400, '404': 1, '500-599': 0 } } })
-  ```
-
-  Read more about these properties in the [`Request` docs](https://developers.cloudflare.com/workers/reference/apis/request/).
-
-  [@trjstewart]: https://github.com/trjstewart
-  [pull/17]: https://github.com/cloudflare/workers-types/pull/17
-  [issue/22]: https://github.com/cloudflare/workers-types/issues/22
-
-- **Add support for `caches.default` - [@ispivey], [@ashnewmanjones], [issue/8], [pull/21]**
-
-  The Workers runtime exposes a default global cache as `caches.default`, accessed like:
-
-  ```typescript
-  let cache = caches.default
-  ```
-
-  This is an extension to the [Service Workers spec for `CacheStorage`](https://w3c.github.io/ServiceWorker/#cachestorage), and thus needed to be added explicitly to our type definitions.
-
-  [@ispivey]: https://github.com/ispivey
-  [@ashnewmanjones]: https://github.com/ashnewmanjones
-  [pull/21]: https://github.com/cloudflare/workers-types/pull/21
-  [issue/8]: https://github.com/cloudflare/workers-types/issues/8
-
-- **Add missing properties to inbound `Request` `cf` object - [@ispivey], [@brycematheson1234], [issue/23], [pull/24], [pull/35]**
-
-  Adds:
-
-  - `clientTcpRtt`
-  - `metroCode`
-  - `botManagement.score`
-  - `botManagement.staticResource`
-  - `botManagement.verifiedBot`
-
-  Makes most geolocation properties optional, because they are not guaranteed to be set on every request.
-
-  Changes the type of `asn` from string to number.
-
-  [@ispivey]: https://github.com/ispivey
-  [@brycematheson1234]: https://github.com/brycematheson1234
-  [issue/23]: https://github.com/cloudflare/workers-types/issues/23
-  [pull/24]: https://github.com/cloudflare/workers-types/pull/24
-  [pull/35]: https://github.com/cloudflare/workers-types/pull/35
-
-- **Adds `cf.cacheKey` property to `RequestInit` - [@ispivey], [issue/22], [pull/28]**
-
-  Adds the `cacheKey` property of the `cf` object to the `RequestInit` interface.
-
-  [@ispivey]: https://github.com/ispivey
-  [pull/28]: https://github.com/cloudflare/workers-types/pull/28
-  [issue/22]: https://github.com/cloudflare/workers-types/issues/22
-
-- **Allow passing another Request as the `init` arg to `Request` constructor - [@ispivey], [issue/15], [pull/18]**
-
-  Previously, this pattern wasn't allowed:
-
-  ```typescript
-  new Request(parsedUrl.toString(), request)
-  ```
-
-  This is because the `cf` object on inbound Request objects, and that expected in the `init` dictionary arg to the Request constructor, have a different shape.
-
-  This change creates explicit `IncomingRequestCfProperties` (inbound) and `RequestInitCfProperties` (outbound) interfaces, and updates the `Request` constructor to accept either type:
-
-  ```typescript
-  interface RequestInit {
-    cf?: RequestInitCfProperties | IncomingRequestCfProperties
-  }
-  ```
-
-  Read more about the `Request` constructor in the [`Request` docs](https://developers.cloudflare.com/workers/reference/apis/request/).
-
-  [@ispivey]: https://github.com/ispivey
-  [pull/18]: https://github.com/cloudflare/workers-types/pull/18
-  [issue/15]: https://github.com/cloudflare/workers-types/issues/15
-
-- **Add `CfRequestInit` type - [@third774], [issue/37], [pull/44]**
-
-  Because of the union mentioned above, if an object is declared as `RequestInit` and sets the `cf` property, subproperties of `cf` can not later be reassigned. For this scenario, a more specific `CfRequestInit` type has been introduced to use instead of `RequestInit` that doesn't exhibit the same assignability issues.
-
-  [@third774]: https://github.com/third774
-  [pull/44]: https://github.com/cloudflare/workers-types/pull/44
-  [issue/37]: https://github.com/cloudflare/workers-types/issues/37
-
-- **Add iterable methods to `FormData`, `Headers`, and `URLSearchParams` - [@ispivey], [issue/25], [pull/26]**
-
-  The iterable methods `entries()`, `keys()` and `values()` are not present on these three types in `lib.webworker.d.ts`. They are instead supplied in `lib.dom.iterable.d.ts`.
-
-  However, as discussed in this issue on the TypeScript repo, `lib.dom.d.ts` and `lib.webworker.d.ts` have conflicting type definitions, and the maintainers hope to solve this issue by refactoring shared components into a new `web.iterable.d.ts` lib: [https://github.com/microsoft/TypeScript/issues/32435#issuecomment-624741120](https://github.com/microsoft/TypeScript/issues/32435#issuecomment-624741120)
-
-  Until then, we will include the iterable methods supported by Workers in our own type definitions.
-
-  [@ispivey]: https://github.com/ispivey
-  [pull/26]: https://github.com/cloudflare/workers-types/pull/26
-  [issue/25]: https://github.com/cloudflare/workers-types/issues/25
-
-### Bugfixes
-
-- **Remove `selector` parameter from `onDocument()` - [@jdanyow], [pull/41]**
-
-  The type signature for HTMLRewriter's `onDocument()` method previously erroneously included a `selector` parameter as its first argument. This has been removed.
-
-  [@jdanyow]: https://github.com/jdanyow
-  [pull/41]: https://github.com/cloudflare/workers-types/pull/41
-
-- **Make `KVNamespace.list()` options argument optional - [@motiejunas], [pull/10]**
-
-  Previously, the `KVNamespace` interface required that callers provide an empty options object when listing all the keys in a namespace, like so:
-
-  ```typescript
-  await NAMESPACE.list({})
-  ```
-
-  However, this argument is not actually required. This change updates the interface to match the runtime.
-
-  [@motiejunas]: https://github.com/motiejunas
-  [pull/10]: https://github.com/cloudflare/workers-types/pull/10
-
-### Maintenance
-
-- **Add a Release Checklist - [@ispivey], [issue/20], [pull/27]**
-
-  As we onboard more contributors, we're documenting release procedures.
-
-  [@ispivey]: https://github.com/ispivey
-  [pull/27]: https://github.com/cloudflare/workers-types/pull/27
-  [issue/20]: https://github.com/cloudflare/workers-types/issues/20
-
-- **Add BSD-3 License - [@ispivey], [issue/31], [pull/30], [pull/40]**
-
-  As we transition this to a project supported by the Cloudflare Workers team, we're releasing the code under a BSD-3 license. Thanks to all the contributors for their help!
-
-  [@ispivey]: https://github.com/ispivey
-  [pull/30]: https://github.com/cloudflare/workers-types/pull/30
-  [pull/40]: https://github.com/cloudflare/workers-types/pull/40
-  [issue/31]: https://github.com/cloudflare/workers-types/issues/31