@hatchet-dev/typescript-sdk 1.0.0-alpha2 → 1.0.1

package/v1/examples/child_workflows/workflow.js

@@ -1,5 +1,4 @@
 "use strict";
-// ❓ Declaring a Child
 var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
     function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
     return new (P || (P = Promise))(function (resolve, reject) {
@@ -11,32 +10,27 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.parent = exports.child = void 0;
+/* eslint-disable no-plusplus */
+// ❓ Declaring a Child
 const hatchet_client_1 = require("../hatchet-client");
-exports.child = hatchet_client_1.hatchet.workflow({
+exports.child = hatchet_client_1.hatchet.task({
     name: 'child',
-});
-exports.child.task({
-    name: 'value',
     fn: (input) => {
         return {
             Value: input.N,
         };
     },
 });
-exports.parent = hatchet_client_1.hatchet.workflow({
+exports.parent = hatchet_client_1.hatchet.task({
     name: 'parent',
-});
-exports.parent.task({
-    name: 'sum',
     fn: (input, ctx) => __awaiter(void 0, void 0, void 0, function* () {
         const n = input.N;
         const promises = [];
-        // eslint-disable-next-line no-plusplus
         for (let i = 0; i < n; i++) {
             promises.push(ctx.runChild(exports.child, { N: i }));
         }
         const childRes = yield Promise.all(promises);
-        const sum = childRes.reduce((acc, curr) => acc + curr.value.Value, 0);
+        const sum = childRes.reduce((acc, curr) => acc + curr.Value, 0);
         return {
             Result: sum,
         };

package/v1/examples/dag/workflow.js

@@ -11,9 +11,12 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.dag = void 0;
 const hatchet_client_1 = require("../hatchet-client");
+// ❓ Declaring a DAG Workflow
+// First, we declare the workflow
 exports.dag = hatchet_client_1.hatchet.workflow({
     name: 'simple',
 });
+// Next, we declare the tasks bound to the workflow
 const toLower = exports.dag.task({
     name: 'to-lower',
     fn: (input) => {
@@ -22,6 +25,7 @@ const toLower = exports.dag.task({
         };
     },
 });
+// Next, we declare the tasks bound to the workflow
 exports.dag.task({
     name: 'reverse',
     parents: [toLower],
@@ -33,3 +37,4 @@ exports.dag.task({
         };
     }),
 });
+// !!

package/v1/examples/landing_page/durable-excution.d.ts

@@ -0,0 +1,3 @@
+export type SimpleInput = {
+    Message: string;
+};

package/v1/examples/landing_page/durable-excution.js

@@ -0,0 +1,40 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+/* eslint-disable @typescript-eslint/no-unused-vars */
+const conditions_1 = require("../../conditions");
+const hatchet_client_1 = require("../hatchet-client");
+function main() {
+    return __awaiter(this, void 0, void 0, function* () {
+        // ❓ Declaring a Durable Task
+        const simple = hatchet_client_1.hatchet.durableTask({
+            name: 'simple',
+            fn: (input, ctx) => __awaiter(this, void 0, void 0, function* () {
+                yield ctx.waitFor((0, conditions_1.Or)({
+                    eventKey: 'user:pay',
+                    expression: 'input.Status == "PAID"',
+                }, {
+                    sleepFor: '24h',
+                }));
+                return {
+                    TransformedMessage: input.Message.toLowerCase(),
+                };
+            }),
+        });
+        // !!
+        // ❓ Running a Task
+        const result = yield simple.run({ Message: 'Hello, World!' });
+        // !!
+    });
+}
+if (require.main === module) {
+    main();
+}

package/v1/examples/landing_page/event-signaling.d.ts

@@ -0,0 +1,6 @@
+export type SimpleInput = {
+    Message: string;
+};
+export declare const simple: import("../..").TaskWorkflowDeclaration<SimpleInput, {
+    TransformedMessage: string;
+}>;

package/v1/examples/landing_page/event-signaling.js

@@ -0,0 +1,16 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.simple = void 0;
+const hatchet_client_1 = require("../hatchet-client");
+// ❓ Trigger on an event
+exports.simple = hatchet_client_1.hatchet.task({
+    name: 'simple',
+    onEvents: ['user:created'],
+    fn: (input) => {
+        // ...
+        return {
+            TransformedMessage: input.Message.toLowerCase(),
+        };
+    },
+});
+// !!

package/v1/examples/landing_page/flow-control.d.ts

@@ -0,0 +1,6 @@
+export type SimpleInput = {
+    Message: string;
+};
+export declare const simple: import("../..").TaskWorkflowDeclaration<SimpleInput, {
+    TransformedMessage: string;
+}>;

package/v1/examples/landing_page/flow-control.js

@@ -0,0 +1,26 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.simple = void 0;
+const workflows_1 = require("../../../protoc/v1/workflows");
+const hatchet_client_1 = require("../hatchet-client");
+// ❓ Process what you can handle
+exports.simple = hatchet_client_1.hatchet.task({
+    name: 'simple',
+    concurrency: {
+        expression: 'input.user_id',
+        limitStrategy: workflows_1.ConcurrencyLimitStrategy.GROUP_ROUND_ROBIN,
+        maxRuns: 1,
+    },
+    rateLimits: [
+        {
+            key: 'api_throttle',
+            units: 1,
+        },
+    ],
+    fn: (input) => {
+        return {
+            TransformedMessage: input.Message.toLowerCase(),
+        };
+    },
+});
+// !!

package/v1/examples/landing_page/queues.d.ts

@@ -0,0 +1,3 @@
+export type SimpleInput = {
+    Message: string;
+};

package/v1/examples/landing_page/queues.js

@@ -0,0 +1,33 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+/* eslint-disable @typescript-eslint/no-unused-vars */
+const hatchet_client_1 = require("../hatchet-client");
+function main() {
+    return __awaiter(this, void 0, void 0, function* () {
+        // ❓ Declaring a Task
+        const simple = hatchet_client_1.hatchet.task({
+            name: 'simple',
+            fn: (input) => {
+                return {
+                    TransformedMessage: input.Message.toLowerCase(),
+                };
+            },
+        });
+        // !!
+        // ❓ Running a Task
+        const result = yield simple.run({ Message: 'Hello, World!' });
+        // !!
+    });
+}
+if (require.main === module) {
+    main();
+}

package/v1/examples/landing_page/scheduling.d.ts

@@ -0,0 +1 @@
+export {};

package/v1/examples/landing_page/scheduling.js

@@ -0,0 +1,12 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const flow_control_1 = require("./flow-control");
+// ❓ Schedules and Crons
+const tomorrow = new Date(Date.now() + 1000 * 60 * 60 * 24);
+const scheduled = flow_control_1.simple.schedule(tomorrow, {
+    Message: 'Hello, World!',
+});
+const cron = flow_control_1.simple.cron('every-day', '0 0 * * *', {
+    Message: 'Hello, World!',
+});
+// !!

package/v1/examples/landing_page/task-routing.d.ts

@@ -0,0 +1,6 @@
+export type SimpleInput = {
+    Message: string;
+};
+export declare const simple: import("../..").TaskWorkflowDeclaration<SimpleInput, {
+    TransformedMessage: string;
+}>;

package/v1/examples/landing_page/task-routing.js

@@ -0,0 +1,25 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.simple = void 0;
+const hatchet_client_1 = require("../hatchet-client");
+// ❓ Route tasks to workers with matching labels
+exports.simple = hatchet_client_1.hatchet.task({
+    name: 'simple',
+    desiredWorkerLabels: {
+        cpu: {
+            value: '2x',
+        },
+    },
+    fn: (input) => {
+        return {
+            TransformedMessage: input.Message.toLowerCase(),
+        };
+    },
+});
+hatchet_client_1.hatchet.worker('task-routing-worker', {
+    workflows: [exports.simple],
+    labels: {
+        cpu: process.env.CPU_LABEL,
+    },
+});
+// !!

package/v1/examples/on_failure/workflow.d.ts

@@ -1 +1 @@
-export declare const alwaysFail: import("../..").WorkflowDeclaration<any, any>;
+export declare const alwaysFail: import("../..").TaskWorkflowDeclaration<import("../../..").JsonObject, never>;

package/v1/examples/on_failure/workflow.js

@@ -13,19 +13,18 @@ exports.alwaysFail = void 0;
 /* eslint-disable no-console */
 const hatchet_client_1 = require("../hatchet-client");
 // ❓ On Failure Task
-exports.alwaysFail = hatchet_client_1.hatchet.workflow({
+exports.alwaysFail = hatchet_client_1.hatchet.task({
     name: 'always-fail',
+    // the onFailure function is called when the task fails
+    // note: not guaranteed to be called on the same worker
     onFailure: (input, ctx) => {
         console.log('onFailure for run:', ctx.workflowRunId());
         return {
             'on-failure': 'success',
         };
     },
-});
-// !!
-exports.alwaysFail.task({
-    name: 'always-fail',
     fn: () => __awaiter(void 0, void 0, void 0, function* () {
         throw new Error('intentional failure');
     }),
 });
+// !!

package/v1/examples/retries/run.d.ts

@@ -0,0 +1 @@
+export {};

package/v1/examples/retries/run.js

@@ -0,0 +1,29 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+/* eslint-disable no-console */
+const workflow_1 = require("./workflow");
+function main() {
+    return __awaiter(this, void 0, void 0, function* () {
+        try {
+            const res = yield workflow_1.retries.run({});
+            console.log(res);
+        }
+        catch (e) {
+            console.log('error', e);
+        }
+    });
+}
+if (require.main === module) {
+    main()
+        .catch(console.error)
+        .finally(() => process.exit(0));
+}

package/v1/examples/retries/worker.d.ts

@@ -0,0 +1 @@
+export {};

package/v1/examples/retries/worker.js

@@ -0,0 +1,24 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const hatchet_client_1 = require("../hatchet-client");
+const workflow_1 = require("./workflow");
+function main() {
+    return __awaiter(this, void 0, void 0, function* () {
+        const worker = yield hatchet_client_1.hatchet.worker('always-fail-worker', {
+            workflows: [workflow_1.retries],
+        });
+        yield worker.start();
+    });
+}
+if (require.main === module) {
+    main();
+}

package/v1/examples/retries/workflow.d.ts

@@ -0,0 +1,5 @@
+export declare const retries: import("../..").TaskWorkflowDeclaration<import("../../..").JsonObject, never>;
+export declare const retriesWithCount: import("../..").TaskWorkflowDeclaration<import("../../..").JsonObject, {
+    message: string;
+}>;
+export declare const withBackoff: import("../..").TaskWorkflowDeclaration<import("../../..").JsonObject, never>;

package/v1/examples/retries/workflow.js

@@ -0,0 +1,53 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.withBackoff = exports.retriesWithCount = exports.retries = void 0;
+/* eslint-disable no-console */
+const hatchet_client_1 = require("../hatchet-client");
+// ❓ Simple Step Retries
+exports.retries = hatchet_client_1.hatchet.task({
+    name: 'retries',
+    retries: 3,
+    fn: (_, ctx) => __awaiter(void 0, void 0, void 0, function* () {
+        throw new Error('intentional failure');
+    }),
+});
+// !!
+// ❓ Step Retries with Count
+exports.retriesWithCount = hatchet_client_1.hatchet.task({
+    name: 'retriesWithCount',
+    retries: 3,
+    fn: (_, ctx) => __awaiter(void 0, void 0, void 0, function* () {
+        // ❓ Get the current retry count
+        const retryCount = ctx.retryCount();
+        console.log(`Retry count: ${retryCount}`);
+        if (retryCount < 2) {
+            throw new Error('intentional failure');
+        }
+        return {
+            message: 'success',
+        };
+    }),
+});
+// !!
+// ❓ Step Retries with Backoff
+exports.withBackoff = hatchet_client_1.hatchet.task({
+    name: 'withBackoff',
+    retries: 3,
+    backoff: {
+        factor: 2,
+        maxSeconds: 10,
+    },
+    fn: () => __awaiter(void 0, void 0, void 0, function* () {
+        throw new Error('intentional failure');
+    }),
+});
+// !!

package/v1/examples/simple/run.js

@@ -10,7 +10,7 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 /* eslint-disable no-console */
-// ❓ Running a Workflow with Results
+// ❓ Running a Task with Results
 const workflow_1 = require("./workflow");
 // ...
 function main() {

package/v1/examples/sticky/run.d.ts

@@ -0,0 +1 @@
+export {};

package/v1/examples/sticky/run.js

@@ -0,0 +1,29 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+/* eslint-disable no-console */
+const workflow_1 = require("../retries/workflow");
+function main() {
+    return __awaiter(this, void 0, void 0, function* () {
+        try {
+            const res = yield workflow_1.retries.run({});
+            console.log(res);
+        }
+        catch (e) {
+            console.log('error', e);
+        }
+    });
+}
+if (require.main === module) {
+    main()
+        .catch(console.error)
+        .finally(() => process.exit(0));
+}

package/v1/examples/sticky/worker.d.ts

@@ -0,0 +1 @@
+export {};

package/v1/examples/sticky/worker.js

@@ -0,0 +1,24 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const hatchet_client_1 = require("../hatchet-client");
+const workflow_1 = require("../retries/workflow");
+function main() {
+    return __awaiter(this, void 0, void 0, function* () {
+        const worker = yield hatchet_client_1.hatchet.worker('always-fail-worker', {
+            workflows: [workflow_1.retries],
+        });
+        yield worker.start();
+    });
+}
+if (require.main === module) {
+    main();
+}

package/v1/examples/sticky/workflow.d.ts

@@ -0,0 +1,5 @@
+export declare const sticky: import("../..").TaskWorkflowDeclaration<import("../../..").JsonObject, {
+    result: {
+        Value: number;
+    };
+}>;

package/v1/examples/sticky/workflow.js

@@ -0,0 +1,32 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.sticky = void 0;
+/* eslint-disable no-console */
+const workflows_1 = require("../../../protoc/workflows");
+const hatchet_client_1 = require("../hatchet-client");
+const workflow_1 = require("../child_workflows/workflow");
+// ❓ Sticky Task
+exports.sticky = hatchet_client_1.hatchet.task({
+    name: 'sticky',
+    retries: 3,
+    sticky: workflows_1.StickyStrategy.SOFT,
+    fn: (_, ctx) => __awaiter(void 0, void 0, void 0, function* () {
+        // specify a child workflow to run on the same worker
+        const result = yield ctx.runChild(workflow_1.child, {
+            N: 1,
+        }, { sticky: true });
+        return {
+            result,
+        };
+    }),
+});
+// !!

package/v1/examples/timeouts/run.d.ts

@@ -0,0 +1 @@
+export {};

package/v1/examples/timeouts/run.js

@@ -0,0 +1,29 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+/* eslint-disable no-console */
+// ❓ Running a Task with Results
+const workflow_1 = require("./workflow");
+// ...
+function main() {
+    return __awaiter(this, void 0, void 0, function* () {
+        // 👀 Run the workflow with results
+        const res = yield workflow_1.cancellation.run({});
+        // 👀 Access the results of the workflow
+        console.log(res.Completed);
+        // !!
+    });
+}
+if (require.main === module) {
+    main()
+        .catch(console.error)
+        .finally(() => process.exit(0));
+}

package/v1/examples/timeouts/worker.d.ts

@@ -0,0 +1 @@
+export {};

package/v1/examples/timeouts/worker.js

@@ -0,0 +1,29 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+// ❓ Declaring a Worker
+const hatchet_client_1 = require("../hatchet-client");
+const workflow_1 = require("./workflow");
+function main() {
+    return __awaiter(this, void 0, void 0, function* () {
+        const worker = yield hatchet_client_1.hatchet.worker('cancellation-worker', {
+            // 👀 Declare the workflows that the worker can execute
+            workflows: [workflow_1.cancellation],
+            // 👀 Declare the number of concurrent task runs the worker can accept
+            slots: 100,
+        });
+        yield worker.start();
+    });
+}
+if (require.main === module) {
+    main();
+}
+// !!

package/v1/examples/timeouts/workflow.d.ts

@@ -0,0 +1,3 @@
+export declare const cancellation: import("../..").TaskWorkflowDeclaration<import("../../..").JsonObject, {
+    Completed: true;
+}>;

package/v1/examples/timeouts/workflow.js

@@ -0,0 +1,34 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.cancellation = void 0;
+// ❓ Declaring a Task
+const sleep_1 = __importDefault(require("../../../util/sleep"));
+const hatchet_client_1 = require("../hatchet-client");
+// (optional) Define the input type for the workflow
+exports.cancellation = hatchet_client_1.hatchet.task({
+    name: 'cancellation',
+    executionTimeout: '3s',
+    fn: (_1, _a) => __awaiter(void 0, [_1, _a], void 0, function* (_, { cancelled }) {
+        yield (0, sleep_1.default)(10 * 1000);
+        if (cancelled) {
+            throw new Error('Task was cancelled');
+        }
+        return {
+            Completed: true,
+        };
+    }),
+});
+// !!
+// see ./worker.ts and ./run.ts for how to run the workflow

package/v1/examples/with_timeouts/workflow.d.ts

@@ -0,0 +1,9 @@
+export type SimpleInput = {
+    Message: string;
+};
+export declare const withTimeouts: import("../..").TaskWorkflowDeclaration<SimpleInput, {
+    TransformedMessage: string;
+}>;
+export declare const refreshTimeout: import("../..").TaskWorkflowDeclaration<SimpleInput, {
+    TransformedMessage: string;
+}>;