Added more schedule examples (#427)

* added more schedule examples

* fixed lint issue

* fixed formatting issues

Author: flippedcoder

schedules/README.md

@@ -40,4 +40,9 @@ You can now run:
   npm run schedule.pause
   npm run schedule.unpause
   npm run schedule.delete
+  npm run schedule.describe
+  npm run schedule.backfill
+  npm run schedule.list
+  npm run schedule.trigger
+  npm run schedule.update
 ```

schedules/package.json

@@ -14,7 +14,12 @@
     "schedule.go-faster": "ts-node src/go-faster.ts",
     "schedule.pause": "ts-node src/pause-schedule.ts",
     "schedule.unpause": "ts-node src/unpause-schedule.ts",
-    "schedule.delete": "ts-node src/delete-schedule.ts"
+    "schedule.delete": "ts-node src/delete-schedule.ts",
+    "schedule.describe": "ts-node src/describe-schedule.ts",
+    "schedule.backfill": "ts-node src/backfill-schedule.ts",
+    "schedule.list": "ts-node src/list-schedule.ts",
+    "schedule.trigger": "ts-node src/trigger-schedule.ts",
+    "schedule.update": "ts-node src/update-schedule.ts"
   },
   "nodemonConfig": {
     "execMap": {

schedules/src/backfill-schedule.ts

@@ -0,0 +1,30 @@
+import { Connection, Client, Backfill, ScheduleOverlapPolicy } from '@temporalio/client';
+
+// @@@SNIPSTART typescript-backfill-a-scheduled-workflow
+function subtractMinutes(minutes: number): Date {
+  const now = new Date();
+  return new Date(now.getTime() - minutes * 60 * 1000);
+}
+
+async function run() {
+  const client = new Client({
+    connection: await Connection.connect(),
+  });
+
+  const backfillOptions: Backfill = {
+    start: subtractMinutes(10),
+    end: subtractMinutes(9),
+    overlap: ScheduleOverlapPolicy.ALLOW_ALL,
+  };
+
+  const handle = client.schedule.getHandle('sample-schedule');
+  await handle.backfill(backfillOptions);
+
+  console.log(`Schedule is now backfilled.`);
+}
+// @@@SNIPEND
+
+run().catch((err) => {
+  console.error(err);
+  process.exit(1);
+});

schedules/src/delete-schedule.ts

@@ -1,5 +1,6 @@
 import { Connection, Client } from '@temporalio/client';
 
+// @@@SNIPSTART typescript-delete-a-scheduled-workflow
 async function run() {
   const client = new Client({
     connection: await Connection.connect(),
@@ -10,6 +11,7 @@ async function run() {
 
   console.log(`Schedule is now deleted.`);
 }
+// @@@SNIPEND
 
 run().catch((err) => {
   console.error(err);

schedules/src/describe-schedule.ts

@@ -0,0 +1,20 @@
+import { Connection, Client } from '@temporalio/client';
+
+// @@@SNIPSTART typescript-describe-a-scheduled-workflow
+async function run() {
+  const client = new Client({
+    connection: await Connection.connect(),
+  });
+
+  const handle = client.schedule.getHandle('sample-schedule');
+
+  const result = await handle.describe();
+
+  console.log(`Schedule description: ${JSON.stringify(result)}`);
+}
+// @@@SNIPEND
+
+run().catch((err) => {
+  console.error(err);
+  process.exit(1);
+});

schedules/src/list-schedule.ts

@@ -0,0 +1,24 @@
+import { Connection, Client } from '@temporalio/client';
+
+// @@@SNIPSTART typescript-list-a-scheduled-workflow
+async function run() {
+  const client = new Client({
+    connection: await Connection.connect(),
+  });
+
+  const schedules = [];
+
+  const scheduleList = client.schedule.list();
+
+  for await (const schedule of scheduleList) {
+    schedules.push(schedule);
+  }
+
+  console.log(`Schedules are now listed: ${JSON.stringify(schedules)}`);
+}
+// @@ SNIPEND
+
+run().catch((err) => {
+  console.error(err);
+  process.exit(1);
+});

schedules/src/pause-schedule.ts

@@ -1,5 +1,6 @@
 import { Connection, Client } from '@temporalio/client';
 
+// @@@SNIPSTART typescript-pause-a-scheduled-workflow
 async function run() {
   const client = new Client({
     connection: await Connection.connect(),
@@ -10,6 +11,7 @@ async function run() {
 
   console.log(`Schedule is now paused.`);
 }
+// @@@SNIPEND
 
 run()
   .then(() => process.exit(0))

schedules/src/start-schedule.ts

@@ -1,6 +1,7 @@
 import { Connection, Client, ScheduleOverlapPolicy } from '@temporalio/client';
 import { reminder } from './workflows';
 
+// @@@SNIPSTART typescript-create-a-scheduled-workflow
 async function run() {
   const client = new Client({
     connection: await Connection.connect(),
@@ -42,6 +43,7 @@ async function run() {
       // ],
     },
   });
+  // @@@SNIPEND
 
   console.log(`Started schedule '${schedule.scheduleId}'.
 
@@ -53,7 +55,12 @@ You can now run:
   npm run schedule.pause
   npm run schedule.unpause
   npm run schedule.delete
-  `);
+  npm run schedule.describe
+  npm run schedule.backfill
+  npm run schedule.list
+  npm run schedule.trigger
+  npm run schedule.update
+`);
 
   await client.connection.close();
 }

schedules/src/trigger-schedule.ts

@@ -0,0 +1,20 @@
+import { Connection, Client } from '@temporalio/client';
+
+// @@@SNIPSTART typescript-trigger-a-scheduled-workflow
+async function run() {
+  const client = new Client({
+    connection: await Connection.connect(),
+  });
+
+  const handle = client.schedule.getHandle('sample-schedule');
+
+  await handle.trigger();
+
+  console.log(`Schedule is now triggered.`);
+}
+// @@@SNIPEND
+
+run().catch((err) => {
+  console.error(err);
+  process.exit(1);
+});

schedules/src/update-schedule.ts

@@ -0,0 +1,37 @@
+import {
+  Connection,
+  Client,
+  ScheduleDescription,
+  ScheduleOptionsStartWorkflowAction,
+  ScheduleUpdateOptions,
+  Workflow,
+} from '@temporalio/client';
+
+// @@@SNIPSTART typescript-update-a-scheduled-workflow
+const updateSchedule = (
+  input: ScheduleDescription,
+): ScheduleUpdateOptions<ScheduleOptionsStartWorkflowAction<Workflow>> => {
+  const scheduleAction = input.action;
+
+  scheduleAction.args = ['my updated schedule arg'];
+
+  return { ...input, ...scheduleAction };
+};
+
+async function run() {
+  const client = new Client({
+    connection: await Connection.connect(),
+  });
+
+  const handle = client.schedule.getHandle('sample-schedule');
+
+  await handle.update(updateSchedule);
+
+  console.log(`Schedule is now updated.`);
+}
+// @@@SNIPEND
+
+run().catch((err) => {
+  console.error(err);
+  process.exit(1);
+});