docs: examples

examples/01-hello-world/hello-job.ts

@@ -0,0 +1,11 @@
+/* eslint-disable no-console */
+
+import { Job } from "sidequest";
+
+export class HelloJob extends Job {
+  run(name: string) {
+    const msg = `hello ${name}`;
+    console.log(msg);
+    return msg;
+  }
+}

examples/01-hello-world/index.ts

@@ -0,0 +1,6 @@
+import { Sidequest } from "sidequest";
+import { HelloJob } from "./hello-job.js";
+
+await Sidequest.start();
+
+await Sidequest.build(HelloJob).enqueue("Jhon");

examples/02-recurring-job/index.ts

@@ -0,0 +1,7 @@
+import { Sidequest } from "sidequest";
+import { SampleJob } from "./sample-job.js";
+
+await Sidequest.start();
+
+// every 10 minutes
+await Sidequest.build(SampleJob).schedule("*/10 * * * * *");

examples/02-recurring-job/sample-job.ts

@@ -0,0 +1,11 @@
+/* eslint-disable no-console */
+
+import { Job } from "sidequest";
+
+export class SampleJob extends Job {
+  run() {
+    const msg = "sample job";
+    console.log(msg);
+    return msg;
+  }
+}

examples/03-snooze-job/index.ts

@@ -0,0 +1,6 @@
+import { Sidequest } from "sidequest";
+import { SnoozeJob } from "./snooze-job.js";
+
+await Sidequest.start();
+
+await Sidequest.build(SnoozeJob).enqueue();

examples/03-snooze-job/snooze-job.ts

@@ -0,0 +1,8 @@
+import { Job } from "sidequest";
+
+export class SnoozeJob extends Job {
+  run() {
+    // Pauses the job for 10 seconds before retrying — can be used to wait for external conditions.
+    return this.snooze(10_000);
+  }
+}

examples/04-enqueue-job-from-api/index.ts

@@ -0,0 +1,20 @@
+/* eslint-disable no-console */
+
+import { Sidequest } from "sidequest";
+
+import express from "express";
+import { SendEmailJob } from "./send-email-job.js";
+
+const app = express();
+
+app.get("/send-email", (req, res) => {
+  const email = req.query.email ?? "[email protected]";
+  void Sidequest.build(SendEmailJob).enqueue(email as string);
+  res.send(204);
+});
+
+await Sidequest.start();
+
+app.listen(3000, () => {
+  console.log("call http://localhost:3000/[email protected]");
+});

examples/04-enqueue-job-from-api/send-email-job.ts

@@ -0,0 +1,11 @@
+/* eslint-disable no-console */
+
+import { Job } from "sidequest";
+
+export class SendEmailJob extends Job {
+  run(email: string) {
+    const msg = `sending email to ${email}`;
+    console.log(msg);
+    return msg;
+  }
+}

examples/05-web-scrapping/count-word-job.ts

@@ -0,0 +1,20 @@
+/* eslint-disable no-console */
+
+import { load } from "cheerio";
+import { Job } from "sidequest";
+
+export class CountWordJob extends Job {
+  async run(url: string, word: string) {
+    const response = await fetch(url);
+    const html = await response.text();
+
+    const $ = load(html);
+    const text = $("body").text();
+
+    const regex = new RegExp(`\\b${word}\\b`, "gi");
+    const matches = text.match(regex);
+    const count = matches ? matches.length : 0;
+
+    console.log(`The word "${word}" appears ${count} times on the page ${url}`);
+  }
+}

examples/05-web-scrapping/index.ts

@@ -0,0 +1,6 @@
+import { Sidequest } from "sidequest";
+import { CountWordJob } from "./count-word-job.js";
+
+await Sidequest.start();
+
+await Sidequest.build(CountWordJob).enqueue("https://en.wikipedia.org/wiki/Node.js", "package");

examples/package.json

@@ -0,0 +1,18 @@
+{
+  "name": "examples",
+  "version": "1.0.0",
+  "type": "module",
+  "private": true,
+  "scripts": {
+    "build": "tsc"
+  },
+  "dependencies": {
+    "cheerio": "^1.1.2",
+    "express": "^5.1.0",
+    "sidequest": "workspace:*"
+  },
+  "devDependencies": {
+    "@types/express": "^5",
+    "typescript": "^5.8.3"
+  }
+}

examples/tsconfig.json

@@ -0,0 +1,20 @@
+{
+  "compilerOptions": {
+    "target": "ES2022",
+    "module": "NodeNext",
+    "moduleResolution": "NodeNext",
+    "lib": ["ES2022"],
+    "esModuleInterop": true,
+    "forceConsistentCasingInFileNames": true,
+    "strict": true,
+    "skipLibCheck": true,
+    "outDir": "dist",
+    "rootDir": ".",
+    "resolveJsonModule": true,
+    "declaration": true,
+    "declarationMap": true,
+    "sourceMap": true
+  },
+  "include": ["."],
+  "exclude": ["dist", "node_modules"]
+}

package.json

@@ -8,7 +8,8 @@
   },
   "workspaces": [
     "packages/*",
-    "packages/backends/*"
+    "packages/backends/*",
+    "examples"
   ],
   "scripts": {
     "build": "cross-env NODE_ENV=production turbo run build",