diff --git a/README.md b/README.md
index 8ddaf00..af194fa 100644
--- a/README.md
+++ b/README.md
@@ -6,7 +6,7 @@ Sophisticated scheduler for durable tasks, built on Durable Object Alarms.
- schedule tasks by time, delay, or cron expression
- schedule multiple tasks on the same object
-- query tasks by name, id, or payload pattern
+- query tasks by description or id (or by time range?)
- cancel tasks
Bonus: This will be particularly useful when wired up with an LLM agent, so you'll be able to schedule tasks by describing them in natural language. Like "remind me to call my friend every monday at 10:00"
@@ -16,8 +16,7 @@ import { Scheduler } from "durable-scheduler";
type Task = {
id: string;
- name: string;
- payload: any;
+ description: string;
time: Date;
} & (
| {
@@ -25,7 +24,7 @@ type Task = {
type: "scheduled";
}
| {
- delay: number;
+ delayInSeconds: number;
type: "delayed";
}
| {
@@ -38,52 +37,38 @@ class MyClass extends Scheduler {
foo() {
// schedule at specific time
this.scheduler.scheduleTask({
- name: "my-task",
+ description: "my-task",
time: new Date(Date.now() + 1000),
- payload: {
- // ...
- },
});
// schedule after a certain amount of time
this.scheduler.scheduleTask({
- name: "my-task",
- delay: 1000, // in ms? s?
- payload: {
- // ...
- },
+ description: "my-task",
+ delayInSeconds: 1000, // in ms? s?
});
// schedule to run periodically
this.scheduler.scheduleTask({
- name: "my-task",
+ description: "my-task",
cron: "*/1 * * * *", // every minute
- payload: {
- // ...
- },
});
- // you can also use an id instead of a name
+ // you can also specify an id
this.scheduler.scheduleTask({
id: "my-task",
time: new Date(Date.now() + 1000),
- payload: {
- // ...
- },
});
// ids must be unique
- // names can be repeated
- // if you don't provide a name or id, it will default to a random uuid
+ // if you don't provide an id, it will default to a random uuid
// if you try to schedule a task with an id that already exists,
// it will overwrite the existing task
// query for tasks
const tasks = this.scheduler.query({
- // by name
+ // by description
// by id
- // by payload pattern matching (?)
// by time range
// some kind of sql syntax here? dunno..
});
diff --git a/eslint.config.mjs b/eslint.config.mjs
index 3f5c3a9..ab1c78c 100644
--- a/eslint.config.mjs
+++ b/eslint.config.mjs
@@ -48,7 +48,8 @@ export default [
"no-undef": "off",
"@typescript-eslint/explicit-module-boundary-types": "off",
"@typescript-eslint/no-unused-vars": ["warn", { argsIgnorePattern: "^_" }],
-
+ "@typescript-eslint/require-await": "off",
+ "@typescript-eslint/await-thenable": "off",
// React rules
...reactPlugin.configs.recommended.rules,
"react/react-in-jsx-scope": "off",
diff --git a/example/README.md b/example/README.md
new file mode 100644
index 0000000..9731e54
--- /dev/null
+++ b/example/README.md
@@ -0,0 +1,7 @@
+This is an example of how to use the `durable-scheduler` package.
+
+The example app is a TODO list app that can schedule tasks to be run at a future date. It is a client side rendered React app that uses tailwind for styling, built with Vite.
+
+We have one input at the top-middle of the page, where you can add a new task. This takes freeform natural language text input (eg: "Buy milk tomorrow at 10am", "Send me a report every friday evening", "Remind me to call my wife in 20 minutes"). We take the input from the user, which is then parsed into a task.
+
+Underneath the input, there is a list of all the tasks that have been scheduled. Each task has a description, a due date, and a status checkbox. We use the status checkbox to mark a task as complete. We can also delete a task altogether by clicking the delete button.
diff --git a/example/src/client/app.tsx b/example/src/client/app.tsx
index a745377..4b9ecbe 100644
--- a/example/src/client/app.tsx
+++ b/example/src/client/app.tsx
@@ -1,3 +1,124 @@
+import { useState } from "react";
+
+import { SqlTask } from "../../../src";
+
+interface ToDo {
+ id: string;
+ inputText: string;
+ parsedTask: SqlTask | undefined;
+ completed: boolean;
+}
+
+// eslint-disable-next-line @typescript-eslint/no-unused-vars
+const ROOM_ID = "username"; // TODO: this will read a username from auth later
+
export default function App() {
- return
Hello World
;
+ const [todos, setTodos] = useState([]);
+ const [inputText, setInputText] = useState("");
+
+ const handleAddToDo = async (e: React.FormEvent) => {
+ e.preventDefault();
+ if (!inputText.trim()) return;
+
+ try {
+ const newToDo: ToDo = {
+ id: crypto.randomUUID(),
+ inputText,
+ parsedTask: undefined,
+ completed: false,
+ };
+
+ setTodos((prev) => [...prev, newToDo]);
+ // TODO: Schedule the task and update the task with the parsedTask
+
+ // let's first convert it to the object that the scheduler expects
+ const result = await fetch("/api/string-to-schedule", {
+ method: "POST",
+ body: inputText,
+ });
+ const parsedTask = await result.json();
+ // eslint-disable-next-line no-console
+ console.log("parsedTask", parsedTask);
+ // ok now let's schedule it
+
+ // TODO: schedule the task
+ setInputText("");
+ } catch (error) {
+ console.error("Failed to parse todo:", error);
+ // You might want to show an error message to the user here
+ }
+ };
+
+ const handleToggleToDo = async (todoId: string) => {
+ setTodos((prev) =>
+ prev.map((todo) => (todo.id === todoId ? { ...todo, completed: !todo.completed } : todo))
+ );
+ };
+
+ const handleDeleteToDo = async (todoId: string) => {
+ // TODO: Cancel the scheduled task
+ setTodos((prev) => prev.filter((todo) => todo.id !== todoId));
+ };
+
+ return (
+