npm - @cloudflare/workers-types - Versions diffs - 4.20230404.0 → 4.20230419.0 - Mend

@cloudflare/workers-types 4.20230404.0 → 4.20230419.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 (19) hide show

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

@@ -49,6 +49,7 @@ declare class DOMException extends Error {
 declare type WorkerGlobalScopeEventMap = {
   fetch: FetchEvent;
   scheduled: ScheduledEvent;
+  queue: QueueEvent;
   unhandledrejection: PromiseRejectionEvent;
   rejectionhandled: PromiseRejectionEvent;
 };
@@ -187,7 +188,8 @@ declare interface ServiceWorkerGlobalScope extends WorkerGlobalScope {
   ExtendableEvent: typeof ExtendableEvent;
   PromiseRejectionEvent: typeof PromiseRejectionEvent;
   FetchEvent: typeof FetchEvent;
-  TraceEvent: typeof TraceEvent;
+  TailEvent: typeof TailEvent;
+  TraceEvent: typeof TailEvent;
   ScheduledEvent: typeof ScheduledEvent;
   MessageEvent: typeof MessageEvent;
   CloseEvent: typeof CloseEvent;
@@ -292,6 +294,11 @@ declare type ExportedHandlerFetchHandler<
   env: Env,
   ctx: ExecutionContext
 ) => Response | Promise<Response>;
+declare type ExportedHandlerTailHandler<Env = unknown> = (
+  events: TraceItem[],
+  env: Env,
+  ctx: ExecutionContext
+) => void | Promise<void>;
 declare type ExportedHandlerTraceHandler<Env = unknown> = (
   traces: TraceItem[],
   env: Env,
@@ -318,10 +325,11 @@ declare interface ExportedHandler<
   CfHostMetadata = unknown
 > {
   fetch?: ExportedHandlerFetchHandler<Env, CfHostMetadata>;
+  tail?: ExportedHandlerTailHandler<Env>;
   trace?: ExportedHandlerTraceHandler<Env>;
   scheduled?: ExportedHandlerScheduledHandler<Env>;
   test?: ExportedHandlerTestHandler<Env>;
-  queue?: ExportedHandlerQueueHandler<Env, QueueMessage>;
+  queue?: ExportedHandlerQueueHandler<Env, Message>;
 }
 declare interface StructuredSerializeOptions {
   transfer?: any[];
@@ -1170,6 +1178,33 @@ declare interface KVNamespaceGetWithMetadataResult<Value, Metadata> {
   value: Value | null;
   metadata: Metadata | null;
 }
+declare interface Queue<Body> {
+  send(message: Body): Promise<void>;
+  sendBatch(messages: Iterable<MessageSendRequest<Body>>): Promise<void>;
+}
+declare interface QueueSendOptions {}
+declare interface MessageSendRequest<Body = unknown> {
+  body: Body;
+}
+declare interface Message<Body = unknown> {
+  readonly id: string;
+  readonly timestamp: Date;
+  readonly body: Body;
+  retry(): void;
+  ack(): void;
+}
+declare interface QueueEvent<Body = unknown> extends ExtendableEvent {
+  readonly messages: readonly Message<Body>[];
+  readonly queue: string;
+  retryAll(): void;
+  ackAll(): void;
+}
+declare interface MessageBatch<Body = unknown> {
+  readonly messages: readonly Message<Body>[];
+  readonly queue: string;
+  retryAll(): void;
+  ackAll(): void;
+}
 declare interface R2Error extends Error {
   readonly name: string;
   readonly code: number;
@@ -1603,7 +1638,8 @@ declare interface QueuingStrategyInit {
    */
   highWaterMark: number;
 }
-declare abstract class TraceEvent extends ExtendableEvent {
+declare abstract class TailEvent extends ExtendableEvent {
+  readonly events: TraceItem[];
   readonly traces: TraceItem[];
 }
 declare interface TraceItem {
@@ -2211,8 +2247,7 @@ declare interface IncomingRequestCfPropertiesBase
 declare interface IncomingRequestCfPropertiesBotManagementBase {
   /**
    * Cloudflare’s [level of certainty](https://developers.cloudflare.com/bots/concepts/bot-score/) that a request comes from a bot,
-   * represented as an integer percentage between `1` (almost certainly human)
-   * and `99` (almost certainly a bot).
+   * represented as an integer percentage between `1` (almost certainly a bot) and `99` (almost certainly human).
    *
    * @example 54
    */
@@ -2957,75 +2992,12 @@ declare interface JsonWebKeyWithKid extends JsonWebKey {
   // Key Identifier of the JWK
   readonly kid: string;
 }
-/**
- * A message that is sent to a consumer Worker.
- */
-declare interface Message<Body = unknown> {
+// https://developers.cloudflare.com/cloudflare-for-platforms/workers-for-platforms/
+declare interface DispatchNamespace {
   /**
-   * A unique, system-generated ID for the message.
+   * @param name Name of the Worker script.
+   * @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.
    */
-  readonly id: string;
-  /**
-   * A timestamp when the message was sent.
-   */
-  readonly timestamp: Date;
-  /**
-   * The body of the message.
-   */
-  readonly body: Body;
-  /**
-   * Marks message to be retried.
-   */
-  retry(): void;
-  /**
-   * Marks message acknowledged.
-   */
-  ack(): void;
-}
-/**
- * A batch of messages that are sent to a consumer Worker.
- */
-declare interface MessageBatch<Body = unknown> {
-  /**
-   * The name of the Queue that belongs to this batch.
-   */
-  readonly queue: string;
-  /**
-   * An array of messages in the batch. Ordering of messages is not guaranteed.
-   */
-  readonly messages: readonly Message<Body>[];
-  /**
-   * Marks every message to be retried in the next batch.
-   */
-  retryAll(): void;
-  /**
-   * Marks every message acknowledged in the batch.
-   */
-  ackAll(): void;
-}
-/**
- * A wrapper class used to structure message batches.
- */
-declare type MessageSendRequest<Body = unknown> = {
-  /**
-   * The body of the message.
-   */
-  body: Body;
-};
-/**
- * A binding that allows a producer to send messages to a Queue.
- */
-declare interface Queue<Body = any> {
-  /**
-   * Sends a message to the Queue.
-   * @param message The message can be any type supported by the [structured clone algorithm](https://developer.mozilla.org/en-US/docs/Web/API/Web_Workers_API/Structured_clone_algorithm#supported_types), as long as its size is less than 128 KB.
-   * @returns A promise that resolves when the message is confirmed to be written to disk.
-   */
-  send(message: Body): Promise<void>;
-  /**
-   * Sends a batch of messages to the Queue.
-   * @param messages Each item in the input must be supported by the [structured clone algorithm](https://developer.mozilla.org/en-US/docs/Web/API/Web_Workers_API/Structured_clone_algorithm#supported_types). A batch can contain up to 100 messages, though items are limited to 128 KB each, and the total size of the array cannot exceed 256 KB.
-   * @returns A promise that resolves when the messages are confirmed to be written to disk.
-   */
-  sendBatch(messages: Iterable<MessageSendRequest<Body>>): Promise<void>;
+  get(name: string): Fetcher;
 }

package/2021-11-03/index.ts CHANGED Viewed

@@ -49,6 +49,7 @@ export declare class DOMException extends Error {
 export type WorkerGlobalScopeEventMap = {
   fetch: FetchEvent;
   scheduled: ScheduledEvent;
+  queue: QueueEvent;
   unhandledrejection: PromiseRejectionEvent;
   rejectionhandled: PromiseRejectionEvent;
 };
@@ -187,7 +188,8 @@ export interface ServiceWorkerGlobalScope extends WorkerGlobalScope {
   ExtendableEvent: typeof ExtendableEvent;
   PromiseRejectionEvent: typeof PromiseRejectionEvent;
   FetchEvent: typeof FetchEvent;
-  TraceEvent: typeof TraceEvent;
+  TailEvent: typeof TailEvent;
+  TraceEvent: typeof TailEvent;
   ScheduledEvent: typeof ScheduledEvent;
   MessageEvent: typeof MessageEvent;
   CloseEvent: typeof CloseEvent;
@@ -294,6 +296,11 @@ export type ExportedHandlerFetchHandler<
   env: Env,
   ctx: ExecutionContext
 ) => Response | Promise<Response>;
+export type ExportedHandlerTailHandler<Env = unknown> = (
+  events: TraceItem[],
+  env: Env,
+  ctx: ExecutionContext
+) => void | Promise<void>;
 export type ExportedHandlerTraceHandler<Env = unknown> = (
   traces: TraceItem[],
   env: Env,
@@ -320,10 +327,11 @@ export interface ExportedHandler<
   CfHostMetadata = unknown
 > {
   fetch?: ExportedHandlerFetchHandler<Env, CfHostMetadata>;
+  tail?: ExportedHandlerTailHandler<Env>;
   trace?: ExportedHandlerTraceHandler<Env>;
   scheduled?: ExportedHandlerScheduledHandler<Env>;
   test?: ExportedHandlerTestHandler<Env>;
-  queue?: ExportedHandlerQueueHandler<Env, QueueMessage>;
+  queue?: ExportedHandlerQueueHandler<Env, Message>;
 }
 export interface StructuredSerializeOptions {
   transfer?: any[];
@@ -1172,6 +1180,33 @@ export interface KVNamespaceGetWithMetadataResult<Value, Metadata> {
   value: Value | null;
   metadata: Metadata | null;
 }
+export interface Queue<Body> {
+  send(message: Body): Promise<void>;
+  sendBatch(messages: Iterable<MessageSendRequest<Body>>): Promise<void>;
+}
+export interface QueueSendOptions {}
+export interface MessageSendRequest<Body = unknown> {
+  body: Body;
+}
+export interface Message<Body = unknown> {
+  readonly id: string;
+  readonly timestamp: Date;
+  readonly body: Body;
+  retry(): void;
+  ack(): void;
+}
+export interface QueueEvent<Body = unknown> extends ExtendableEvent {
+  readonly messages: readonly Message<Body>[];
+  readonly queue: string;
+  retryAll(): void;
+  ackAll(): void;
+}
+export interface MessageBatch<Body = unknown> {
+  readonly messages: readonly Message<Body>[];
+  readonly queue: string;
+  retryAll(): void;
+  ackAll(): void;
+}
 export interface R2Error extends Error {
   readonly name: string;
   readonly code: number;
@@ -1608,7 +1643,8 @@ export interface QueuingStrategyInit {
    */
   highWaterMark: number;
 }
-export declare abstract class TraceEvent extends ExtendableEvent {
+export declare abstract class TailEvent extends ExtendableEvent {
+  readonly events: TraceItem[];
   readonly traces: TraceItem[];
 }
 export interface TraceItem {
@@ -2216,8 +2252,7 @@ export interface IncomingRequestCfPropertiesBase
 export interface IncomingRequestCfPropertiesBotManagementBase {
   /**
    * Cloudflare’s [level of certainty](https://developers.cloudflare.com/bots/concepts/bot-score/) that a request comes from a bot,
-   * represented as an integer percentage between `1` (almost certainly human)
-   * and `99` (almost certainly a bot).
+   * represented as an integer percentage between `1` (almost certainly a bot) and `99` (almost certainly human).
    *
    * @example 54
    */
@@ -2952,75 +2987,12 @@ export interface JsonWebKeyWithKid extends JsonWebKey {
   // Key Identifier of the JWK
   readonly kid: string;
 }
-/**
- * A message that is sent to a consumer Worker.
- */
-export interface Message<Body = unknown> {
+// https://developers.cloudflare.com/cloudflare-for-platforms/workers-for-platforms/
+export interface DispatchNamespace {
   /**
-   * A unique, system-generated ID for the message.
+   * @param name Name of the Worker script.
+   * @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.
    */
-  readonly id: string;
-  /**
-   * A timestamp when the message was sent.
-   */
-  readonly timestamp: Date;
-  /**
-   * The body of the message.
-   */
-  readonly body: Body;
-  /**
-   * Marks message to be retried.
-   */
-  retry(): void;
-  /**
-   * Marks message acknowledged.
-   */
-  ack(): void;
-}
-/**
- * A batch of messages that are sent to a consumer Worker.
- */
-export interface MessageBatch<Body = unknown> {
-  /**
-   * The name of the Queue that belongs to this batch.
-   */
-  readonly queue: string;
-  /**
-   * An array of messages in the batch. Ordering of messages is not guaranteed.
-   */
-  readonly messages: readonly Message<Body>[];
-  /**
-   * Marks every message to be retried in the next batch.
-   */
-  retryAll(): void;
-  /**
-   * Marks every message acknowledged in the batch.
-   */
-  ackAll(): void;
-}
-/**
- * A wrapper class used to structure message batches.
- */
-export type MessageSendRequest<Body = unknown> = {
-  /**
-   * The body of the message.
-   */
-  body: Body;
-};
-/**
- * A binding that allows a producer to send messages to a Queue.
- */
-export interface Queue<Body = any> {
-  /**
-   * Sends a message to the Queue.
-   * @param message The message can be any type supported by the [structured clone algorithm](https://developer.mozilla.org/en-US/docs/Web/API/Web_Workers_API/Structured_clone_algorithm#supported_types), as long as its size is less than 128 KB.
-   * @returns A promise that resolves when the message is confirmed to be written to disk.
-   */
-  send(message: Body): Promise<void>;
-  /**
-   * Sends a batch of messages to the Queue.
-   * @param messages Each item in the input must be supported by the [structured clone algorithm](https://developer.mozilla.org/en-US/docs/Web/API/Web_Workers_API/Structured_clone_algorithm#supported_types). A batch can contain up to 100 messages, though items are limited to 128 KB each, and the total size of the array cannot exceed 256 KB.
-   * @returns A promise that resolves when the messages are confirmed to be written to disk.
-   */
-  sendBatch(messages: Iterable<MessageSendRequest<Body>>): Promise<void>;
+  get(name: string): Fetcher;
 }

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

@@ -49,6 +49,7 @@ declare class DOMException extends Error {
 declare type WorkerGlobalScopeEventMap = {
   fetch: FetchEvent;
   scheduled: ScheduledEvent;
+  queue: QueueEvent;
   unhandledrejection: PromiseRejectionEvent;
   rejectionhandled: PromiseRejectionEvent;
 };
@@ -187,7 +188,8 @@ declare interface ServiceWorkerGlobalScope extends WorkerGlobalScope {
   ExtendableEvent: typeof ExtendableEvent;
   PromiseRejectionEvent: typeof PromiseRejectionEvent;
   FetchEvent: typeof FetchEvent;
-  TraceEvent: typeof TraceEvent;
+  TailEvent: typeof TailEvent;
+  TraceEvent: typeof TailEvent;
   ScheduledEvent: typeof ScheduledEvent;
   MessageEvent: typeof MessageEvent;
   CloseEvent: typeof CloseEvent;
@@ -292,6 +294,11 @@ declare type ExportedHandlerFetchHandler<
   env: Env,
   ctx: ExecutionContext
 ) => Response | Promise<Response>;
+declare type ExportedHandlerTailHandler<Env = unknown> = (
+  events: TraceItem[],
+  env: Env,
+  ctx: ExecutionContext
+) => void | Promise<void>;
 declare type ExportedHandlerTraceHandler<Env = unknown> = (
   traces: TraceItem[],
   env: Env,
@@ -318,10 +325,11 @@ declare interface ExportedHandler<
   CfHostMetadata = unknown
 > {
   fetch?: ExportedHandlerFetchHandler<Env, CfHostMetadata>;
+  tail?: ExportedHandlerTailHandler<Env>;
   trace?: ExportedHandlerTraceHandler<Env>;
   scheduled?: ExportedHandlerScheduledHandler<Env>;
   test?: ExportedHandlerTestHandler<Env>;
-  queue?: ExportedHandlerQueueHandler<Env, QueueMessage>;
+  queue?: ExportedHandlerQueueHandler<Env, Message>;
 }
 declare interface StructuredSerializeOptions {
   transfer?: any[];
@@ -1150,6 +1158,33 @@ declare interface KVNamespaceGetWithMetadataResult<Value, Metadata> {
   value: Value | null;
   metadata: Metadata | null;
 }
+declare interface Queue<Body> {
+  send(message: Body): Promise<void>;
+  sendBatch(messages: Iterable<MessageSendRequest<Body>>): Promise<void>;
+}
+declare interface QueueSendOptions {}
+declare interface MessageSendRequest<Body = unknown> {
+  body: Body;
+}
+declare interface Message<Body = unknown> {
+  readonly id: string;
+  readonly timestamp: Date;
+  readonly body: Body;
+  retry(): void;
+  ack(): void;
+}
+declare interface QueueEvent<Body = unknown> extends ExtendableEvent {
+  readonly messages: readonly Message<Body>[];
+  readonly queue: string;
+  retryAll(): void;
+  ackAll(): void;
+}
+declare interface MessageBatch<Body = unknown> {
+  readonly messages: readonly Message<Body>[];
+  readonly queue: string;
+  retryAll(): void;
+  ackAll(): void;
+}
 declare interface R2Error extends Error {
   readonly name: string;
   readonly code: number;
@@ -1583,7 +1618,8 @@ declare interface QueuingStrategyInit {
    */
   highWaterMark: number;
 }
-declare abstract class TraceEvent extends ExtendableEvent {
+declare abstract class TailEvent extends ExtendableEvent {
+  readonly events: TraceItem[];
   readonly traces: TraceItem[];
 }
 declare interface TraceItem {
@@ -2197,8 +2233,7 @@ declare interface IncomingRequestCfPropertiesBase
 declare interface IncomingRequestCfPropertiesBotManagementBase {
   /**
    * Cloudflare’s [level of certainty](https://developers.cloudflare.com/bots/concepts/bot-score/) that a request comes from a bot,
-   * represented as an integer percentage between `1` (almost certainly human)
-   * and `99` (almost certainly a bot).
+   * represented as an integer percentage between `1` (almost certainly a bot) and `99` (almost certainly human).
    *
    * @example 54
    */
@@ -2943,75 +2978,12 @@ declare interface JsonWebKeyWithKid extends JsonWebKey {
   // Key Identifier of the JWK
   readonly kid: string;
 }
-/**
- * A message that is sent to a consumer Worker.
- */
-declare interface Message<Body = unknown> {
+// https://developers.cloudflare.com/cloudflare-for-platforms/workers-for-platforms/
+declare interface DispatchNamespace {
   /**
-   * A unique, system-generated ID for the message.
+   * @param name Name of the Worker script.
+   * @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.
    */
-  readonly id: string;
-  /**
-   * A timestamp when the message was sent.
-   */
-  readonly timestamp: Date;
-  /**
-   * The body of the message.
-   */
-  readonly body: Body;
-  /**
-   * Marks message to be retried.
-   */
-  retry(): void;
-  /**
-   * Marks message acknowledged.
-   */
-  ack(): void;
-}
-/**
- * A batch of messages that are sent to a consumer Worker.
- */
-declare interface MessageBatch<Body = unknown> {
-  /**
-   * The name of the Queue that belongs to this batch.
-   */
-  readonly queue: string;
-  /**
-   * An array of messages in the batch. Ordering of messages is not guaranteed.
-   */
-  readonly messages: readonly Message<Body>[];
-  /**
-   * Marks every message to be retried in the next batch.
-   */
-  retryAll(): void;
-  /**
-   * Marks every message acknowledged in the batch.
-   */
-  ackAll(): void;
-}
-/**
- * A wrapper class used to structure message batches.
- */
-declare type MessageSendRequest<Body = unknown> = {
-  /**
-   * The body of the message.
-   */
-  body: Body;
-};
-/**
- * A binding that allows a producer to send messages to a Queue.
- */
-declare interface Queue<Body = any> {
-  /**
-   * Sends a message to the Queue.
-   * @param message The message can be any type supported by the [structured clone algorithm](https://developer.mozilla.org/en-US/docs/Web/API/Web_Workers_API/Structured_clone_algorithm#supported_types), as long as its size is less than 128 KB.
-   * @returns A promise that resolves when the message is confirmed to be written to disk.
-   */
-  send(message: Body): Promise<void>;
-  /**
-   * Sends a batch of messages to the Queue.
-   * @param messages Each item in the input must be supported by the [structured clone algorithm](https://developer.mozilla.org/en-US/docs/Web/API/Web_Workers_API/Structured_clone_algorithm#supported_types). A batch can contain up to 100 messages, though items are limited to 128 KB each, and the total size of the array cannot exceed 256 KB.
-   * @returns A promise that resolves when the messages are confirmed to be written to disk.
-   */
-  sendBatch(messages: Iterable<MessageSendRequest<Body>>): Promise<void>;
+  get(name: string): Fetcher;
 }