@cinnabun/scheduler 0.0.1 → 0.0.7

package/README.md

@@ -0,0 +1,63 @@
+# @cinnabun/scheduler
+
+Scheduled tasks for Cinnabun. Cron-style jobs with decorators.
+
+## Installation
+
+```bash
+bun add @cinnabun/scheduler
+```
+
+## Quick Start
+
+```typescript
+import { CinnabunApp, CinnabunFactory } from "@cinnabun/core";
+import { SchedulerModule, SchedulerPlugin } from "@cinnabun/scheduler";
+
+@CinnabunApp({
+  port: 3000,
+  scanPaths: [],
+  imports: [SchedulerModule.forRoot()],
+  plugins: [new SchedulerPlugin()],
+})
+class App {}
+
+CinnabunFactory.run(App);
+```
+
+## Scheduled tasks
+
+```typescript
+import { Scheduled } from "@cinnabun/scheduler";
+
+@Service()
+class CleanupService {
+  @Scheduled("0 0 * * *") // Every day at midnight
+  async cleanupExpiredSessions() {
+    // ...
+  }
+
+  @Scheduled("*/5 * * * *") // Every 5 minutes
+  async syncData() {
+    // ...
+  }
+}
+```
+
+## Cron format
+
+Cron expressions use the standard 5-field format:
+
+```
+* * * * *
+│ │ │ │ │
+│ │ │ │ └─ day of week (0-7)
+│ │ │ └─── month (1-12)
+│ │ └───── day of month (1-31)
+│ └─────── hour (0-23)
+└───────── minute (0-59)
+```
+
+## License
+
+MIT

package/dist/scheduler.module.d.ts

@@ -1,5 +1,6 @@
+import { type Constructor } from "@cinnabun/core";
 import type { SchedulerModuleOptions } from "./interfaces/scheduler-options.js";
 export declare class SchedulerModule {
-    static forRoot(options?: SchedulerModuleOptions): Function;
+    static forRoot(options?: SchedulerModuleOptions): Constructor;
     static getOptions(): SchedulerModuleOptions;
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@cinnabun/scheduler",
-  "version": "0.0.1",
+  "version": "0.0.7",
   "description": "Task scheduler for Cinnabun with cron and Spring-style fixedRate/fixedDelay",
   "type": "module",
   "main": "dist/index.js",