@cloudflare/workers-types 4.20240821.1 → 4.20240909.0

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

@@ -235,6 +235,7 @@ interface ServiceWorkerGlobalScope extends WorkerGlobalScope {
   caches: CacheStorage;
   scheduler: Scheduler;
   performance: Performance;
+  Cloudflare: Cloudflare;
   readonly origin: string;
   Event: typeof Event;
   ExtendableEvent: typeof ExtendableEvent;
@@ -384,6 +385,7 @@ declare const scheduler: Scheduler;
  * [Cloudflare Docs Reference](https://developers.cloudflare.com/workers/runtime-apis/performance/)
  */
 declare const performance: Performance;
+declare const Cloudflare: Cloudflare;
 declare const origin: string;
 interface TestController {}
 interface ExecutionContext {
@@ -459,6 +461,9 @@ interface AlarmInvocationInfo {
   readonly isRetry: boolean;
   readonly retryCount: number;
 }
+interface Cloudflare {
+  readonly compatibilityFlags: Record<string, boolean>;
+}
 interface DurableObject {
   fetch(request: Request): Response | Promise<Response>;
   alarm?(): void | Promise<void>;
@@ -534,6 +539,7 @@ interface DurableObjectState {
   setHibernatableWebSocketEventTimeout(timeoutMs?: number): void;
   getHibernatableWebSocketEventTimeout(): number | null;
   getTags(ws: WebSocket): string[];
+  abort(reason?: string): void;
 }
 interface DurableObjectTransaction {
   get<T = unknown>(
@@ -600,7 +606,11 @@ interface DurableObjectStorage {
   ): Promise<void>;
   deleteAlarm(options?: DurableObjectSetAlarmOptions): Promise<void>;
   sync(): Promise<void>;
+  sql: SqlStorage;
   transactionSync<T>(closure: () => T): T;
+  getCurrentBookmark(): Promise<string>;
+  getBookmarkForTime(timestamp: number | Date): Promise<string>;
+  onNextSessionRestoreBookmark(bookmark: string): Promise<string>;
 }
 interface DurableObjectListOptions {
   start?: string;
@@ -2242,15 +2252,15 @@ declare class TransformStream<I = any, O = any> {
 }
 declare class FixedLengthStream extends IdentityTransformStream {
   constructor(
-    expectedLength: number | bigint,
-    queuingStrategy?: IdentityTransformStreamQueuingStrategy,
+    param1: number | bigint,
+    param2?: IdentityTransformStreamQueuingStrategy,
   );
 }
 declare class IdentityTransformStream extends TransformStream<
   ArrayBuffer | ArrayBufferView,
   Uint8Array
 > {
-  constructor(queuingStrategy?: IdentityTransformStreamQueuingStrategy);
+  constructor(param1?: IdentityTransformStreamQueuingStrategy);
 }
 interface IdentityTransformStreamQueuingStrategy {
   highWaterMark?: number | bigint;
@@ -2282,7 +2292,7 @@ declare class TextDecoderStream extends TransformStream<
   ArrayBuffer | ArrayBufferView,
   string
 > {
-  constructor(label?: string, options?: TextDecoderStreamTextDecoderStreamInit);
+  constructor(param1?: string, param2?: TextDecoderStreamTextDecoderStreamInit);
   get encoding(): string;
   get fatal(): boolean;
   get ignoreBOM(): boolean;
@@ -2708,6 +2718,23 @@ declare const WebSocketPair: {
     1: WebSocket;
   };
 };
+interface SqlStorage {
+  exec(query: string, ...bindings: any[]): SqlStorageCursor;
+  prepare(query: string): SqlStorageStatement;
+  get databaseSize(): number;
+  Cursor: typeof SqlStorageCursor;
+  Statement: typeof SqlStorageStatement;
+}
+declare abstract class SqlStorageStatement {}
+declare abstract class SqlStorageCursor {
+  raw(): IterableIterator<((ArrayBuffer | string | number) | null)[]>;
+  get columnNames(): string[];
+  get rowsRead(): number;
+  get rowsWritten(): number;
+  [Symbol.iterator](): IterableIterator<
+    Record<string, (ArrayBuffer | string | number) | null>
+  >;
+}
 interface Socket {
   get readable(): ReadableStream;
   get writable(): WritableStream;
@@ -4885,6 +4912,30 @@ type PagesPluginFunction<
 declare module "assets:*" {
   export const onRequest: PagesFunction;
 }
+// Copyright (c) 2022-2023 Cloudflare, Inc.
+// Licensed under the Apache 2.0 license found in the LICENSE file or at:
+//     https://opensource.org/licenses/Apache-2.0
+declare abstract class PipelineTransform {
+  /**
+   * transformJson recieves an array of javascript objects which can be
+   * mutated and returned to the pipeline
+   * @param data The data to be mutated
+   * @returns A promise containing the mutated data
+   */
+  public transformJson(data: object[]): Promise<object[]>;
+}
+// Copyright (c) 2022-2023 Cloudflare, Inc.
+// Licensed under the Apache 2.0 license found in the LICENSE file or at:
+//     https://opensource.org/licenses/Apache-2.0
+interface Pipeline {
+  /**
+   * send takes an array of javascript objects which are
+   * then received by the pipeline for processing
+   *
+   * @param data The data to be sent
+   */
+  send(data: object[]): Promise<void>;
+}
 // PubSubMessage represents an incoming PubSub message.
 // The message includes metadata about the broker, the client, and the payload
 // itself.
@@ -5151,6 +5202,10 @@ declare module "cloudflare:workers" {
     };
     timeout?: string | number;
   };
+  export type WorkflowEvent<T> = {
+    payload: T;
+    timestamp: Date;
+  };
   export type WorkflowStep = {
     do: <T extends Rpc.Serializable>(
       name: string,
@@ -5170,13 +5225,7 @@ declare module "cloudflare:workers" {
     [Rpc.__WORKFLOW_BRAND]: never;
     protected ctx: ExecutionContext;
     protected env: Env;
-    run(
-      events: Array<{
-        payload: T;
-        timestamp: Date;
-      }>,
-      step: WorkflowStep,
-    ): Promise<unknown>;
+    run(events: Array<WorkflowEvent<T>>, step: WorkflowStep): Promise<unknown>;
   }
 }
 declare module "cloudflare:sockets" {
@@ -5480,3 +5529,13 @@ interface DispatchNamespace {
     options?: DynamicDispatchOptions,
   ): Fetcher;
 }
+/**
+ * NonRetryableError allows for a Workflow to throw a "fatal" error as in,
+ * an error that makes the instance fail immediately without triggering a retry.
+ */
+declare class NonRetryableError extends Error {
+  // __brand has been explicity omitted because it's a internal brand used for
+  // the Workflows' engine and user's shouldn't be able to override it
+  // (at least, in a direct way)
+  public constructor(message: string, name?: string);
+}

package/2021-11-03/index.ts

@@ -235,6 +235,7 @@ export interface ServiceWorkerGlobalScope extends WorkerGlobalScope {
   caches: CacheStorage;
   scheduler: Scheduler;
   performance: Performance;
+  Cloudflare: Cloudflare;
   readonly origin: string;
   Event: typeof Event;
   ExtendableEvent: typeof ExtendableEvent;
@@ -386,6 +387,7 @@ export declare const scheduler: Scheduler;
  * [Cloudflare Docs Reference](https://developers.cloudflare.com/workers/runtime-apis/performance/)
  */
 export declare const performance: Performance;
+export declare const Cloudflare: Cloudflare;
 export declare const origin: string;
 export interface TestController {}
 export interface ExecutionContext {
@@ -464,6 +466,9 @@ export interface AlarmInvocationInfo {
   readonly isRetry: boolean;
   readonly retryCount: number;
 }
+export interface Cloudflare {
+  readonly compatibilityFlags: Record<string, boolean>;
+}
 export interface DurableObject {
   fetch(request: Request): Response | Promise<Response>;
   alarm?(): void | Promise<void>;
@@ -539,6 +544,7 @@ export interface DurableObjectState {
   setHibernatableWebSocketEventTimeout(timeoutMs?: number): void;
   getHibernatableWebSocketEventTimeout(): number | null;
   getTags(ws: WebSocket): string[];
+  abort(reason?: string): void;
 }
 export interface DurableObjectTransaction {
   get<T = unknown>(
@@ -605,7 +611,11 @@ export interface DurableObjectStorage {
   ): Promise<void>;
   deleteAlarm(options?: DurableObjectSetAlarmOptions): Promise<void>;
   sync(): Promise<void>;
+  sql: SqlStorage;
   transactionSync<T>(closure: () => T): T;
+  getCurrentBookmark(): Promise<string>;
+  getBookmarkForTime(timestamp: number | Date): Promise<string>;
+  onNextSessionRestoreBookmark(bookmark: string): Promise<string>;
 }
 export interface DurableObjectListOptions {
   start?: string;
@@ -2248,15 +2258,15 @@ export declare class TransformStream<I = any, O = any> {
 }
 export declare class FixedLengthStream extends IdentityTransformStream {
   constructor(
-    expectedLength: number | bigint,
-    queuingStrategy?: IdentityTransformStreamQueuingStrategy,
+    param1: number | bigint,
+    param2?: IdentityTransformStreamQueuingStrategy,
   );
 }
 export declare class IdentityTransformStream extends TransformStream<
   ArrayBuffer | ArrayBufferView,
   Uint8Array
 > {
-  constructor(queuingStrategy?: IdentityTransformStreamQueuingStrategy);
+  constructor(param1?: IdentityTransformStreamQueuingStrategy);
 }
 export interface IdentityTransformStreamQueuingStrategy {
   highWaterMark?: number | bigint;
@@ -2291,7 +2301,7 @@ export declare class TextDecoderStream extends TransformStream<
   ArrayBuffer | ArrayBufferView,
   string
 > {
-  constructor(label?: string, options?: TextDecoderStreamTextDecoderStreamInit);
+  constructor(param1?: string, param2?: TextDecoderStreamTextDecoderStreamInit);
   get encoding(): string;
   get fatal(): boolean;
   get ignoreBOM(): boolean;
@@ -2717,6 +2727,23 @@ export declare const WebSocketPair: {
     1: WebSocket;
   };
 };
+export interface SqlStorage {
+  exec(query: string, ...bindings: any[]): SqlStorageCursor;
+  prepare(query: string): SqlStorageStatement;
+  get databaseSize(): number;
+  Cursor: typeof SqlStorageCursor;
+  Statement: typeof SqlStorageStatement;
+}
+export declare abstract class SqlStorageStatement {}
+export declare abstract class SqlStorageCursor {
+  raw(): IterableIterator<((ArrayBuffer | string | number) | null)[]>;
+  get columnNames(): string[];
+  get rowsRead(): number;
+  get rowsWritten(): number;
+  [Symbol.iterator](): IterableIterator<
+    Record<string, (ArrayBuffer | string | number) | null>
+  >;
+}
 export interface Socket {
   get readable(): ReadableStream;
   get writable(): WritableStream;
@@ -4897,6 +4924,30 @@ export type PagesPluginFunction<
 > = (
   context: EventPluginContext<Env, Params, Data, PluginArgs>,
 ) => Response | Promise<Response>;
+// Copyright (c) 2022-2023 Cloudflare, Inc.
+// Licensed under the Apache 2.0 license found in the LICENSE file or at:
+//     https://opensource.org/licenses/Apache-2.0
+export declare abstract class PipelineTransform {
+  /**
+   * transformJson recieves an array of javascript objects which can be
+   * mutated and returned to the pipeline
+   * @param data The data to be mutated
+   * @returns A promise containing the mutated data
+   */
+  public transformJson(data: object[]): Promise<object[]>;
+}
+// Copyright (c) 2022-2023 Cloudflare, Inc.
+// Licensed under the Apache 2.0 license found in the LICENSE file or at:
+//     https://opensource.org/licenses/Apache-2.0
+export interface Pipeline {
+  /**
+   * send takes an array of javascript objects which are
+   * then received by the pipeline for processing
+   *
+   * @param data The data to be sent
+   */
+  send(data: object[]): Promise<void>;
+}
 // PubSubMessage represents an incoming PubSub message.
 // The message includes metadata about the broker, the client, and the payload
 // itself.
@@ -5393,3 +5444,13 @@ export interface DispatchNamespace {
     options?: DynamicDispatchOptions,
   ): Fetcher;
 }
+/**
+ * NonRetryableError allows for a Workflow to throw a "fatal" error as in,
+ * an error that makes the instance fail immediately without triggering a retry.
+ */
+export declare class NonRetryableError extends Error {
+  // __brand has been explicity omitted because it's a internal brand used for
+  // the Workflows' engine and user's shouldn't be able to override it
+  // (at least, in a direct way)
+  public constructor(message: string, name?: string);
+}

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

@@ -235,6 +235,7 @@ interface ServiceWorkerGlobalScope extends WorkerGlobalScope {
   caches: CacheStorage;
   scheduler: Scheduler;
   performance: Performance;
+  Cloudflare: Cloudflare;
   readonly origin: string;
   Event: typeof Event;
   ExtendableEvent: typeof ExtendableEvent;
@@ -384,6 +385,7 @@ declare const scheduler: Scheduler;
  * [Cloudflare Docs Reference](https://developers.cloudflare.com/workers/runtime-apis/performance/)
  */
 declare const performance: Performance;
+declare const Cloudflare: Cloudflare;
 declare const origin: string;
 interface TestController {}
 interface ExecutionContext {
@@ -459,6 +461,9 @@ interface AlarmInvocationInfo {
   readonly isRetry: boolean;
   readonly retryCount: number;
 }
+interface Cloudflare {
+  readonly compatibilityFlags: Record<string, boolean>;
+}
 interface DurableObject {
   fetch(request: Request): Response | Promise<Response>;
   alarm?(): void | Promise<void>;
@@ -534,6 +539,7 @@ interface DurableObjectState {
   setHibernatableWebSocketEventTimeout(timeoutMs?: number): void;
   getHibernatableWebSocketEventTimeout(): number | null;
   getTags(ws: WebSocket): string[];
+  abort(reason?: string): void;
 }
 interface DurableObjectTransaction {
   get<T = unknown>(
@@ -600,7 +606,11 @@ interface DurableObjectStorage {
   ): Promise<void>;
   deleteAlarm(options?: DurableObjectSetAlarmOptions): Promise<void>;
   sync(): Promise<void>;
+  sql: SqlStorage;
   transactionSync<T>(closure: () => T): T;
+  getCurrentBookmark(): Promise<string>;
+  getBookmarkForTime(timestamp: number | Date): Promise<string>;
+  onNextSessionRestoreBookmark(bookmark: string): Promise<string>;
 }
 interface DurableObjectListOptions {
   start?: string;
@@ -2248,15 +2258,15 @@ declare class TransformStream<I = any, O = any> {
 }
 declare class FixedLengthStream extends IdentityTransformStream {
   constructor(
-    expectedLength: number | bigint,
-    queuingStrategy?: IdentityTransformStreamQueuingStrategy,
+    param1: number | bigint,
+    param2?: IdentityTransformStreamQueuingStrategy,
   );
 }
 declare class IdentityTransformStream extends TransformStream<
   ArrayBuffer | ArrayBufferView,
   Uint8Array
 > {
-  constructor(queuingStrategy?: IdentityTransformStreamQueuingStrategy);
+  constructor(param1?: IdentityTransformStreamQueuingStrategy);
 }
 interface IdentityTransformStreamQueuingStrategy {
   highWaterMark?: number | bigint;
@@ -2288,7 +2298,7 @@ declare class TextDecoderStream extends TransformStream<
   ArrayBuffer | ArrayBufferView,
   string
 > {
-  constructor(label?: string, options?: TextDecoderStreamTextDecoderStreamInit);
+  constructor(param1?: string, param2?: TextDecoderStreamTextDecoderStreamInit);
   get encoding(): string;
   get fatal(): boolean;
   get ignoreBOM(): boolean;
@@ -2734,6 +2744,23 @@ declare const WebSocketPair: {
     1: WebSocket;
   };
 };
+interface SqlStorage {
+  exec(query: string, ...bindings: any[]): SqlStorageCursor;
+  prepare(query: string): SqlStorageStatement;
+  get databaseSize(): number;
+  Cursor: typeof SqlStorageCursor;
+  Statement: typeof SqlStorageStatement;
+}
+declare abstract class SqlStorageStatement {}
+declare abstract class SqlStorageCursor {
+  raw(): IterableIterator<((ArrayBuffer | string | number) | null)[]>;
+  get columnNames(): string[];
+  get rowsRead(): number;
+  get rowsWritten(): number;
+  [Symbol.iterator](): IterableIterator<
+    Record<string, (ArrayBuffer | string | number) | null>
+  >;
+}
 interface Socket {
   get readable(): ReadableStream;
   get writable(): WritableStream;
@@ -4911,6 +4938,30 @@ type PagesPluginFunction<
 declare module "assets:*" {
   export const onRequest: PagesFunction;
 }
+// Copyright (c) 2022-2023 Cloudflare, Inc.
+// Licensed under the Apache 2.0 license found in the LICENSE file or at:
+//     https://opensource.org/licenses/Apache-2.0
+declare abstract class PipelineTransform {
+  /**
+   * transformJson recieves an array of javascript objects which can be
+   * mutated and returned to the pipeline
+   * @param data The data to be mutated
+   * @returns A promise containing the mutated data
+   */
+  public transformJson(data: object[]): Promise<object[]>;
+}
+// Copyright (c) 2022-2023 Cloudflare, Inc.
+// Licensed under the Apache 2.0 license found in the LICENSE file or at:
+//     https://opensource.org/licenses/Apache-2.0
+interface Pipeline {
+  /**
+   * send takes an array of javascript objects which are
+   * then received by the pipeline for processing
+   *
+   * @param data The data to be sent
+   */
+  send(data: object[]): Promise<void>;
+}
 // PubSubMessage represents an incoming PubSub message.
 // The message includes metadata about the broker, the client, and the payload
 // itself.
@@ -5177,6 +5228,10 @@ declare module "cloudflare:workers" {
     };
     timeout?: string | number;
   };
+  export type WorkflowEvent<T> = {
+    payload: T;
+    timestamp: Date;
+  };
   export type WorkflowStep = {
     do: <T extends Rpc.Serializable>(
       name: string,
@@ -5196,13 +5251,7 @@ declare module "cloudflare:workers" {
     [Rpc.__WORKFLOW_BRAND]: never;
     protected ctx: ExecutionContext;
     protected env: Env;
-    run(
-      events: Array<{
-        payload: T;
-        timestamp: Date;
-      }>,
-      step: WorkflowStep,
-    ): Promise<unknown>;
+    run(events: Array<WorkflowEvent<T>>, step: WorkflowStep): Promise<unknown>;
   }
 }
 declare module "cloudflare:sockets" {
@@ -5506,3 +5555,13 @@ interface DispatchNamespace {
     options?: DynamicDispatchOptions,
   ): Fetcher;
 }
+/**
+ * NonRetryableError allows for a Workflow to throw a "fatal" error as in,
+ * an error that makes the instance fail immediately without triggering a retry.
+ */
+declare class NonRetryableError extends Error {
+  // __brand has been explicity omitted because it's a internal brand used for
+  // the Workflows' engine and user's shouldn't be able to override it
+  // (at least, in a direct way)
+  public constructor(message: string, name?: string);
+}

package/2022-01-31/index.ts

@@ -235,6 +235,7 @@ export interface ServiceWorkerGlobalScope extends WorkerGlobalScope {
   caches: CacheStorage;
   scheduler: Scheduler;
   performance: Performance;
+  Cloudflare: Cloudflare;
   readonly origin: string;
   Event: typeof Event;
   ExtendableEvent: typeof ExtendableEvent;
@@ -386,6 +387,7 @@ export declare const scheduler: Scheduler;
  * [Cloudflare Docs Reference](https://developers.cloudflare.com/workers/runtime-apis/performance/)
  */
 export declare const performance: Performance;
+export declare const Cloudflare: Cloudflare;
 export declare const origin: string;
 export interface TestController {}
 export interface ExecutionContext {
@@ -464,6 +466,9 @@ export interface AlarmInvocationInfo {
   readonly isRetry: boolean;
   readonly retryCount: number;
 }
+export interface Cloudflare {
+  readonly compatibilityFlags: Record<string, boolean>;
+}
 export interface DurableObject {
   fetch(request: Request): Response | Promise<Response>;
   alarm?(): void | Promise<void>;
@@ -539,6 +544,7 @@ export interface DurableObjectState {
   setHibernatableWebSocketEventTimeout(timeoutMs?: number): void;
   getHibernatableWebSocketEventTimeout(): number | null;
   getTags(ws: WebSocket): string[];
+  abort(reason?: string): void;
 }
 export interface DurableObjectTransaction {
   get<T = unknown>(
@@ -605,7 +611,11 @@ export interface DurableObjectStorage {
   ): Promise<void>;
   deleteAlarm(options?: DurableObjectSetAlarmOptions): Promise<void>;
   sync(): Promise<void>;
+  sql: SqlStorage;
   transactionSync<T>(closure: () => T): T;
+  getCurrentBookmark(): Promise<string>;
+  getBookmarkForTime(timestamp: number | Date): Promise<string>;
+  onNextSessionRestoreBookmark(bookmark: string): Promise<string>;
 }
 export interface DurableObjectListOptions {
   start?: string;
@@ -2254,15 +2264,15 @@ export declare class TransformStream<I = any, O = any> {
 }
 export declare class FixedLengthStream extends IdentityTransformStream {
   constructor(
-    expectedLength: number | bigint,
-    queuingStrategy?: IdentityTransformStreamQueuingStrategy,
+    param1: number | bigint,
+    param2?: IdentityTransformStreamQueuingStrategy,
   );
 }
 export declare class IdentityTransformStream extends TransformStream<
   ArrayBuffer | ArrayBufferView,
   Uint8Array
 > {
-  constructor(queuingStrategy?: IdentityTransformStreamQueuingStrategy);
+  constructor(param1?: IdentityTransformStreamQueuingStrategy);
 }
 export interface IdentityTransformStreamQueuingStrategy {
   highWaterMark?: number | bigint;
@@ -2297,7 +2307,7 @@ export declare class TextDecoderStream extends TransformStream<
   ArrayBuffer | ArrayBufferView,
   string
 > {
-  constructor(label?: string, options?: TextDecoderStreamTextDecoderStreamInit);
+  constructor(param1?: string, param2?: TextDecoderStreamTextDecoderStreamInit);
   get encoding(): string;
   get fatal(): boolean;
   get ignoreBOM(): boolean;
@@ -2743,6 +2753,23 @@ export declare const WebSocketPair: {
     1: WebSocket;
   };
 };
+export interface SqlStorage {
+  exec(query: string, ...bindings: any[]): SqlStorageCursor;
+  prepare(query: string): SqlStorageStatement;
+  get databaseSize(): number;
+  Cursor: typeof SqlStorageCursor;
+  Statement: typeof SqlStorageStatement;
+}
+export declare abstract class SqlStorageStatement {}
+export declare abstract class SqlStorageCursor {
+  raw(): IterableIterator<((ArrayBuffer | string | number) | null)[]>;
+  get columnNames(): string[];
+  get rowsRead(): number;
+  get rowsWritten(): number;
+  [Symbol.iterator](): IterableIterator<
+    Record<string, (ArrayBuffer | string | number) | null>
+  >;
+}
 export interface Socket {
   get readable(): ReadableStream;
   get writable(): WritableStream;
@@ -4923,6 +4950,30 @@ export type PagesPluginFunction<
 > = (
   context: EventPluginContext<Env, Params, Data, PluginArgs>,
 ) => Response | Promise<Response>;
+// Copyright (c) 2022-2023 Cloudflare, Inc.
+// Licensed under the Apache 2.0 license found in the LICENSE file or at:
+//     https://opensource.org/licenses/Apache-2.0
+export declare abstract class PipelineTransform {
+  /**
+   * transformJson recieves an array of javascript objects which can be
+   * mutated and returned to the pipeline
+   * @param data The data to be mutated
+   * @returns A promise containing the mutated data
+   */
+  public transformJson(data: object[]): Promise<object[]>;
+}
+// Copyright (c) 2022-2023 Cloudflare, Inc.
+// Licensed under the Apache 2.0 license found in the LICENSE file or at:
+//     https://opensource.org/licenses/Apache-2.0
+export interface Pipeline {
+  /**
+   * send takes an array of javascript objects which are
+   * then received by the pipeline for processing
+   *
+   * @param data The data to be sent
+   */
+  send(data: object[]): Promise<void>;
+}
 // PubSubMessage represents an incoming PubSub message.
 // The message includes metadata about the broker, the client, and the payload
 // itself.
@@ -5419,3 +5470,13 @@ export interface DispatchNamespace {
     options?: DynamicDispatchOptions,
   ): Fetcher;
 }
+/**
+ * NonRetryableError allows for a Workflow to throw a "fatal" error as in,
+ * an error that makes the instance fail immediately without triggering a retry.
+ */
+export declare class NonRetryableError extends Error {
+  // __brand has been explicity omitted because it's a internal brand used for
+  // the Workflows' engine and user's shouldn't be able to override it
+  // (at least, in a direct way)
+  public constructor(message: string, name?: string);
+}