chore: wip

Author: chrisbbreuer

.stacks/core/types/src/cron-jobs.ts

@@ -6,8 +6,9 @@ export interface CronJobOptions {
    * The name of the cron job.
    */
   name?: string
-  action: string | Function
-  schedule: string
+  action?: string | Function
+  run?: string | Function
+  schedule?: string
   description?: string
   enabled?: boolean
   timezone?: string

app/jobs/demo-job.ts

@@ -0,0 +1,13 @@
+import { log } from '@stacksjs/cli'
+import { Every } from '@stacksjs/types'
+import type { CronJob } from '@stacksjs/types'
+
+export default {
+  name: 'Demo Job', // defaults to the file name
+  description: 'A demo cron job that runs every 5th minute', // optional
+  schedule: Every.FifthMinute, // optional, run it on a schedule. alternatively, '*/5 * * * *'
+  run: () => { // or `action: () => {`
+    log.info('This cron job runs at every 5th minute')
+  },
+  // `run: 'demo-job'` is another option where `demo-job` refers to ./resources/functions/demo-job.ts
+} satisfies CronJob