@cloudflare/workers-types 4.20230321.0 → 4.20230404.0

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

@@ -353,13 +353,24 @@ declare interface DurableObjectNamespace {
     id: DurableObjectId,
     options?: DurableObjectNamespaceGetDurableObjectOptions
   ): DurableObjectStub;
-  jurisdiction(jurisdiction: string): DurableObjectNamespace;
+  jurisdiction(jurisdiction: DurableObjectJurisdiction): DurableObjectNamespace;
 }
+declare type DurableObjectJurisdiction = "eu" | "fedramp";
 declare interface DurableObjectNamespaceNewUniqueIdOptions {
-  jurisdiction?: string;
-}
+  jurisdiction?: DurableObjectJurisdiction;
+}
+declare type DurableObjectLocationHint =
+  | "wnam"
+  | "enam"
+  | "sam"
+  | "weur"
+  | "eeur"
+  | "apac"
+  | "oc"
+  | "afr"
+  | "me";
 declare interface DurableObjectNamespaceGetDurableObjectOptions {
-  locationHint?: string;
+  locationHint?: DurableObjectLocationHint;
 }
 declare interface DurableObjectState {
   waitUntil(promise: Promise<any>): void;
@@ -1309,12 +1320,18 @@ declare interface R2HTTPMetadata {
   cacheControl?: string;
   cacheExpiry?: Date;
 }
-declare interface R2Objects {
+declare type R2Objects = {
   objects: R2Object[];
-  truncated: boolean;
-  cursor?: string;
   delimitedPrefixes: string[];
-}
+} & (
+  | {
+      truncated: true;
+      cursor: string;
+    }
+  | {
+      truncated: false;
+    }
+);
 declare abstract class ScheduledEvent extends ExtendableEvent {
   readonly scheduledTime: number;
   readonly cron: string;
@@ -1525,13 +1542,19 @@ declare class TransformStream<I = any, O = any> {
   readonly writable: WritableStream<I>;
 }
 declare class FixedLengthStream extends IdentityTransformStream {
-  constructor(expectedLength: number | bigint);
+  constructor(
+    expectedLength: number | bigint,
+    queuingStrategy?: IdentityTransformStreamQueuingStrategy
+  );
 }
 declare class IdentityTransformStream extends TransformStream<
   ArrayBuffer | ArrayBufferView,
   Uint8Array
 > {
-  constructor();
+  constructor(queuingStrategy?: IdentityTransformStreamQueuingStrategy);
+}
+declare interface IdentityTransformStreamQueuingStrategy {
+  highWaterMark?: number | bigint;
 }
 declare interface ReadableStreamValuesOptions {
   preventCancel?: boolean;
@@ -2791,7 +2814,7 @@ declare abstract class D1PreparedStatement {
   raw<T = unknown>(): Promise<T[]>;
 }
 /**
- * A email message that is sent to a consumer Worker.
+ * An email message that can be sent from a Worker.
  */
 declare interface EmailMessage {
   /**
@@ -2802,14 +2825,19 @@ declare interface EmailMessage {
    * Envelope To attribute of the email message.
    */
   readonly to: string;
-  /**
-   * A [Headers object](https://developer.mozilla.org/en-US/docs/Web/API/Headers).
-   */
-  readonly headers: Headers;
+}
+/**
+ * An email message that is sent to a consumer Worker and can be rejected/forwarded.
+ */
+declare interface ForwardableEmailMessage extends EmailMessage {
   /**
    * Stream of the email message content.
    */
   readonly raw: ReadableStream;
+  /**
+   * An [Headers object](https://developer.mozilla.org/en-US/docs/Web/API/Headers).
+   */
+  readonly headers: Headers;
   /**
    * Size of the email message content.
    */
@@ -2828,14 +2856,27 @@ declare interface EmailMessage {
    */
   forward(rcptTo: string, headers?: Headers): Promise<void>;
 }
+/**
+ * A binding that allows a Worker to send email messages.
+ */
+declare interface SendEmail {
+  send(message: EmailMessage): Promise<void>;
+}
 declare abstract class EmailEvent extends ExtendableEvent {
-  readonly message: EmailMessage;
+  readonly message: ForwardableEmailMessage;
 }
 declare type EmailExportedHandler<Env = unknown> = (
-  message: EmailMessage,
+  message: ForwardableEmailMessage,
   env: Env,
   ctx: ExecutionContext
 ) => void | Promise<void>;
+declare module "cloudflare:email" {
+  let _EmailMessage: {
+    prototype: EmailMessage;
+    new (from: string, to: string, raw: ReadableStream | string): EmailMessage;
+  };
+  export { _EmailMessage as EmailMessage };
+}
 declare type Params<P extends string = any> = Record<P, string | string[]>;
 declare type EventContext<Env, P extends string, Data> = {
   request: Request;

package/2021-11-03/index.ts

@@ -355,13 +355,24 @@ export interface DurableObjectNamespace {
     id: DurableObjectId,
     options?: DurableObjectNamespaceGetDurableObjectOptions
   ): DurableObjectStub;
-  jurisdiction(jurisdiction: string): DurableObjectNamespace;
+  jurisdiction(jurisdiction: DurableObjectJurisdiction): DurableObjectNamespace;
 }
+export type DurableObjectJurisdiction = "eu" | "fedramp";
 export interface DurableObjectNamespaceNewUniqueIdOptions {
-  jurisdiction?: string;
-}
+  jurisdiction?: DurableObjectJurisdiction;
+}
+export type DurableObjectLocationHint =
+  | "wnam"
+  | "enam"
+  | "sam"
+  | "weur"
+  | "eeur"
+  | "apac"
+  | "oc"
+  | "afr"
+  | "me";
 export interface DurableObjectNamespaceGetDurableObjectOptions {
-  locationHint?: string;
+  locationHint?: DurableObjectLocationHint;
 }
 export interface DurableObjectState {
   waitUntil(promise: Promise<any>): void;
@@ -1311,12 +1322,18 @@ export interface R2HTTPMetadata {
   cacheControl?: string;
   cacheExpiry?: Date;
 }
-export interface R2Objects {
+export type R2Objects = {
   objects: R2Object[];
-  truncated: boolean;
-  cursor?: string;
   delimitedPrefixes: string[];
-}
+} & (
+  | {
+      truncated: true;
+      cursor: string;
+    }
+  | {
+      truncated: false;
+    }
+);
 export declare abstract class ScheduledEvent extends ExtendableEvent {
   readonly scheduledTime: number;
   readonly cron: string;
@@ -1527,13 +1544,19 @@ export declare class TransformStream<I = any, O = any> {
   readonly writable: WritableStream<I>;
 }
 export declare class FixedLengthStream extends IdentityTransformStream {
-  constructor(expectedLength: number | bigint);
+  constructor(
+    expectedLength: number | bigint,
+    queuingStrategy?: IdentityTransformStreamQueuingStrategy
+  );
 }
 export declare class IdentityTransformStream extends TransformStream<
   ArrayBuffer | ArrayBufferView,
   Uint8Array
 > {
-  constructor();
+  constructor(queuingStrategy?: IdentityTransformStreamQueuingStrategy);
+}
+export interface IdentityTransformStreamQueuingStrategy {
+  highWaterMark?: number | bigint;
 }
 export interface ReadableStreamValuesOptions {
   preventCancel?: boolean;
@@ -2796,7 +2819,7 @@ export declare abstract class D1PreparedStatement {
   raw<T = unknown>(): Promise<T[]>;
 }
 /**
- * A email message that is sent to a consumer Worker.
+ * An email message that can be sent from a Worker.
  */
 export interface EmailMessage {
   /**
@@ -2807,14 +2830,19 @@ export interface EmailMessage {
    * Envelope To attribute of the email message.
    */
   readonly to: string;
-  /**
-   * A [Headers object](https://developer.mozilla.org/en-US/docs/Web/API/Headers).
-   */
-  readonly headers: Headers;
+}
+/**
+ * An email message that is sent to a consumer Worker and can be rejected/forwarded.
+ */
+export interface ForwardableEmailMessage extends EmailMessage {
   /**
    * Stream of the email message content.
    */
   readonly raw: ReadableStream;
+  /**
+   * An [Headers object](https://developer.mozilla.org/en-US/docs/Web/API/Headers).
+   */
+  readonly headers: Headers;
   /**
    * Size of the email message content.
    */
@@ -2833,11 +2861,17 @@ export interface EmailMessage {
    */
   forward(rcptTo: string, headers?: Headers): Promise<void>;
 }
+/**
+ * A binding that allows a Worker to send email messages.
+ */
+export interface SendEmail {
+  send(message: EmailMessage): Promise<void>;
+}
 export declare abstract class EmailEvent extends ExtendableEvent {
-  readonly message: EmailMessage;
+  readonly message: ForwardableEmailMessage;
 }
 export type EmailExportedHandler<Env = unknown> = (
-  message: EmailMessage,
+  message: ForwardableEmailMessage,
   env: Env,
   ctx: ExecutionContext
 ) => void | Promise<void>;

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

@@ -353,13 +353,24 @@ declare interface DurableObjectNamespace {
     id: DurableObjectId,
     options?: DurableObjectNamespaceGetDurableObjectOptions
   ): DurableObjectStub;
-  jurisdiction(jurisdiction: string): DurableObjectNamespace;
+  jurisdiction(jurisdiction: DurableObjectJurisdiction): DurableObjectNamespace;
 }
+declare type DurableObjectJurisdiction = "eu" | "fedramp";
 declare interface DurableObjectNamespaceNewUniqueIdOptions {
-  jurisdiction?: string;
-}
+  jurisdiction?: DurableObjectJurisdiction;
+}
+declare type DurableObjectLocationHint =
+  | "wnam"
+  | "enam"
+  | "sam"
+  | "weur"
+  | "eeur"
+  | "apac"
+  | "oc"
+  | "afr"
+  | "me";
 declare interface DurableObjectNamespaceGetDurableObjectOptions {
-  locationHint?: string;
+  locationHint?: DurableObjectLocationHint;
 }
 declare interface DurableObjectState {
   waitUntil(promise: Promise<any>): void;
@@ -1289,12 +1300,18 @@ declare interface R2HTTPMetadata {
   cacheControl?: string;
   cacheExpiry?: Date;
 }
-declare interface R2Objects {
+declare type R2Objects = {
   objects: R2Object[];
-  truncated: boolean;
-  cursor?: string;
   delimitedPrefixes: string[];
-}
+} & (
+  | {
+      truncated: true;
+      cursor: string;
+    }
+  | {
+      truncated: false;
+    }
+);
 declare abstract class ScheduledEvent extends ExtendableEvent {
   readonly scheduledTime: number;
   readonly cron: string;
@@ -1505,13 +1522,19 @@ declare class TransformStream<I = any, O = any> {
   get writable(): WritableStream<I>;
 }
 declare class FixedLengthStream extends IdentityTransformStream {
-  constructor(expectedLength: number | bigint);
+  constructor(
+    expectedLength: number | bigint,
+    queuingStrategy?: IdentityTransformStreamQueuingStrategy
+  );
 }
 declare class IdentityTransformStream extends TransformStream<
   ArrayBuffer | ArrayBufferView,
   Uint8Array
 > {
-  constructor();
+  constructor(queuingStrategy?: IdentityTransformStreamQueuingStrategy);
+}
+declare interface IdentityTransformStreamQueuingStrategy {
+  highWaterMark?: number | bigint;
 }
 declare interface ReadableStreamValuesOptions {
   preventCancel?: boolean;
@@ -2777,7 +2800,7 @@ declare abstract class D1PreparedStatement {
   raw<T = unknown>(): Promise<T[]>;
 }
 /**
- * A email message that is sent to a consumer Worker.
+ * An email message that can be sent from a Worker.
  */
 declare interface EmailMessage {
   /**
@@ -2788,14 +2811,19 @@ declare interface EmailMessage {
    * Envelope To attribute of the email message.
    */
   readonly to: string;
-  /**
-   * A [Headers object](https://developer.mozilla.org/en-US/docs/Web/API/Headers).
-   */
-  readonly headers: Headers;
+}
+/**
+ * An email message that is sent to a consumer Worker and can be rejected/forwarded.
+ */
+declare interface ForwardableEmailMessage extends EmailMessage {
   /**
    * Stream of the email message content.
    */
   readonly raw: ReadableStream;
+  /**
+   * An [Headers object](https://developer.mozilla.org/en-US/docs/Web/API/Headers).
+   */
+  readonly headers: Headers;
   /**
    * Size of the email message content.
    */
@@ -2814,14 +2842,27 @@ declare interface EmailMessage {
    */
   forward(rcptTo: string, headers?: Headers): Promise<void>;
 }
+/**
+ * A binding that allows a Worker to send email messages.
+ */
+declare interface SendEmail {
+  send(message: EmailMessage): Promise<void>;
+}
 declare abstract class EmailEvent extends ExtendableEvent {
-  readonly message: EmailMessage;
+  readonly message: ForwardableEmailMessage;
 }
 declare type EmailExportedHandler<Env = unknown> = (
-  message: EmailMessage,
+  message: ForwardableEmailMessage,
   env: Env,
   ctx: ExecutionContext
 ) => void | Promise<void>;
+declare module "cloudflare:email" {
+  let _EmailMessage: {
+    prototype: EmailMessage;
+    new (from: string, to: string, raw: ReadableStream | string): EmailMessage;
+  };
+  export { _EmailMessage as EmailMessage };
+}
 declare type Params<P extends string = any> = Record<P, string | string[]>;
 declare type EventContext<Env, P extends string, Data> = {
   request: Request;

package/2022-01-31/index.ts

@@ -355,13 +355,24 @@ export interface DurableObjectNamespace {
     id: DurableObjectId,
     options?: DurableObjectNamespaceGetDurableObjectOptions
   ): DurableObjectStub;
-  jurisdiction(jurisdiction: string): DurableObjectNamespace;
+  jurisdiction(jurisdiction: DurableObjectJurisdiction): DurableObjectNamespace;
 }
+export type DurableObjectJurisdiction = "eu" | "fedramp";
 export interface DurableObjectNamespaceNewUniqueIdOptions {
-  jurisdiction?: string;
-}
+  jurisdiction?: DurableObjectJurisdiction;
+}
+export type DurableObjectLocationHint =
+  | "wnam"
+  | "enam"
+  | "sam"
+  | "weur"
+  | "eeur"
+  | "apac"
+  | "oc"
+  | "afr"
+  | "me";
 export interface DurableObjectNamespaceGetDurableObjectOptions {
-  locationHint?: string;
+  locationHint?: DurableObjectLocationHint;
 }
 export interface DurableObjectState {
   waitUntil(promise: Promise<any>): void;
@@ -1291,12 +1302,18 @@ export interface R2HTTPMetadata {
   cacheControl?: string;
   cacheExpiry?: Date;
 }
-export interface R2Objects {
+export type R2Objects = {
   objects: R2Object[];
-  truncated: boolean;
-  cursor?: string;
   delimitedPrefixes: string[];
-}
+} & (
+  | {
+      truncated: true;
+      cursor: string;
+    }
+  | {
+      truncated: false;
+    }
+);
 export declare abstract class ScheduledEvent extends ExtendableEvent {
   readonly scheduledTime: number;
   readonly cron: string;
@@ -1507,13 +1524,19 @@ export declare class TransformStream<I = any, O = any> {
   get writable(): WritableStream<I>;
 }
 export declare class FixedLengthStream extends IdentityTransformStream {
-  constructor(expectedLength: number | bigint);
+  constructor(
+    expectedLength: number | bigint,
+    queuingStrategy?: IdentityTransformStreamQueuingStrategy
+  );
 }
 export declare class IdentityTransformStream extends TransformStream<
   ArrayBuffer | ArrayBufferView,
   Uint8Array
 > {
-  constructor();
+  constructor(queuingStrategy?: IdentityTransformStreamQueuingStrategy);
+}
+export interface IdentityTransformStreamQueuingStrategy {
+  highWaterMark?: number | bigint;
 }
 export interface ReadableStreamValuesOptions {
   preventCancel?: boolean;
@@ -2782,7 +2805,7 @@ export declare abstract class D1PreparedStatement {
   raw<T = unknown>(): Promise<T[]>;
 }
 /**
- * A email message that is sent to a consumer Worker.
+ * An email message that can be sent from a Worker.
  */
 export interface EmailMessage {
   /**
@@ -2793,14 +2816,19 @@ export interface EmailMessage {
    * Envelope To attribute of the email message.
    */
   readonly to: string;
-  /**
-   * A [Headers object](https://developer.mozilla.org/en-US/docs/Web/API/Headers).
-   */
-  readonly headers: Headers;
+}
+/**
+ * An email message that is sent to a consumer Worker and can be rejected/forwarded.
+ */
+export interface ForwardableEmailMessage extends EmailMessage {
   /**
    * Stream of the email message content.
    */
   readonly raw: ReadableStream;
+  /**
+   * An [Headers object](https://developer.mozilla.org/en-US/docs/Web/API/Headers).
+   */
+  readonly headers: Headers;
   /**
    * Size of the email message content.
    */
@@ -2819,11 +2847,17 @@ export interface EmailMessage {
    */
   forward(rcptTo: string, headers?: Headers): Promise<void>;
 }
+/**
+ * A binding that allows a Worker to send email messages.
+ */
+export interface SendEmail {
+  send(message: EmailMessage): Promise<void>;
+}
 export declare abstract class EmailEvent extends ExtendableEvent {
-  readonly message: EmailMessage;
+  readonly message: ForwardableEmailMessage;
 }
 export type EmailExportedHandler<Env = unknown> = (
-  message: EmailMessage,
+  message: ForwardableEmailMessage,
   env: Env,
   ctx: ExecutionContext
 ) => void | Promise<void>;

package/2022-03-21/index.d.ts

@@ -359,13 +359,24 @@ declare interface DurableObjectNamespace {
     id: DurableObjectId,
     options?: DurableObjectNamespaceGetDurableObjectOptions
   ): DurableObjectStub;
-  jurisdiction(jurisdiction: string): DurableObjectNamespace;
+  jurisdiction(jurisdiction: DurableObjectJurisdiction): DurableObjectNamespace;
 }
+declare type DurableObjectJurisdiction = "eu" | "fedramp";
 declare interface DurableObjectNamespaceNewUniqueIdOptions {
-  jurisdiction?: string;
-}
+  jurisdiction?: DurableObjectJurisdiction;
+}
+declare type DurableObjectLocationHint =
+  | "wnam"
+  | "enam"
+  | "sam"
+  | "weur"
+  | "eeur"
+  | "apac"
+  | "oc"
+  | "afr"
+  | "me";
 declare interface DurableObjectNamespaceGetDurableObjectOptions {
-  locationHint?: string;
+  locationHint?: DurableObjectLocationHint;
 }
 declare interface DurableObjectState {
   waitUntil(promise: Promise<any>): void;
@@ -1295,12 +1306,18 @@ declare interface R2HTTPMetadata {
   cacheControl?: string;
   cacheExpiry?: Date;
 }
-declare interface R2Objects {
+declare type R2Objects = {
   objects: R2Object[];
-  truncated: boolean;
-  cursor?: string;
   delimitedPrefixes: string[];
-}
+} & (
+  | {
+      truncated: true;
+      cursor: string;
+    }
+  | {
+      truncated: false;
+    }
+);
 declare abstract class ScheduledEvent extends ExtendableEvent {
   readonly scheduledTime: number;
   readonly cron: string;
@@ -1511,13 +1528,19 @@ declare class TransformStream<I = any, O = any> {
   get writable(): WritableStream<I>;
 }
 declare class FixedLengthStream extends IdentityTransformStream {
-  constructor(expectedLength: number | bigint);
+  constructor(
+    expectedLength: number | bigint,
+    queuingStrategy?: IdentityTransformStreamQueuingStrategy
+  );
 }
 declare class IdentityTransformStream extends TransformStream<
   ArrayBuffer | ArrayBufferView,
   Uint8Array
 > {
-  constructor();
+  constructor(queuingStrategy?: IdentityTransformStreamQueuingStrategy);
+}
+declare interface IdentityTransformStreamQueuingStrategy {
+  highWaterMark?: number | bigint;
 }
 declare interface ReadableStreamValuesOptions {
   preventCancel?: boolean;
@@ -2783,7 +2806,7 @@ declare abstract class D1PreparedStatement {
   raw<T = unknown>(): Promise<T[]>;
 }
 /**
- * A email message that is sent to a consumer Worker.
+ * An email message that can be sent from a Worker.
  */
 declare interface EmailMessage {
   /**
@@ -2794,14 +2817,19 @@ declare interface EmailMessage {
    * Envelope To attribute of the email message.
    */
   readonly to: string;
-  /**
-   * A [Headers object](https://developer.mozilla.org/en-US/docs/Web/API/Headers).
-   */
-  readonly headers: Headers;
+}
+/**
+ * An email message that is sent to a consumer Worker and can be rejected/forwarded.
+ */
+declare interface ForwardableEmailMessage extends EmailMessage {
   /**
    * Stream of the email message content.
    */
   readonly raw: ReadableStream;
+  /**
+   * An [Headers object](https://developer.mozilla.org/en-US/docs/Web/API/Headers).
+   */
+  readonly headers: Headers;
   /**
    * Size of the email message content.
    */
@@ -2820,14 +2848,27 @@ declare interface EmailMessage {
    */
   forward(rcptTo: string, headers?: Headers): Promise<void>;
 }
+/**
+ * A binding that allows a Worker to send email messages.
+ */
+declare interface SendEmail {
+  send(message: EmailMessage): Promise<void>;
+}
 declare abstract class EmailEvent extends ExtendableEvent {
-  readonly message: EmailMessage;
+  readonly message: ForwardableEmailMessage;
 }
 declare type EmailExportedHandler<Env = unknown> = (
-  message: EmailMessage,
+  message: ForwardableEmailMessage,
   env: Env,
   ctx: ExecutionContext
 ) => void | Promise<void>;
+declare module "cloudflare:email" {
+  let _EmailMessage: {
+    prototype: EmailMessage;
+    new (from: string, to: string, raw: ReadableStream | string): EmailMessage;
+  };
+  export { _EmailMessage as EmailMessage };
+}
 declare type Params<P extends string = any> = Record<P, string | string[]>;
 declare type EventContext<Env, P extends string, Data> = {
   request: Request;