nuxt-scheduler

Nuxt Scheduler

Schedule Jobs within Nuxt 3.

• ✨  Release Notes

Features

• 👩🏼‍🌾 human readable
• 😌 easy to use

Quick Setup

1. Add nuxt-scheduler dependency to your project

# Using pnpm
pnpm add -D nuxt-scheduler

# Using yarn
yarn add --dev nuxt-scheduler

# Using npm
npm install --save-dev nuxt-scheduler

1. Add nuxt-scheduler to the modules section of nuxt.config.ts

export default defineNuxtConfig({
  modules: [
    'nuxt-scheduler'
  ]
})

That's it! You can now use Nuxt Scheduler in your Nuxt app ✨

Example Usage

You must create a file here

~/server/app/scheduler.ts

import { useScheduler } from "#scheduler";
import say from "~/server/app/services/say";

export default function startScheduler() {
  const scheduler = useScheduler();

  scheduler.start();

  scheduler.run(() => {
    say("this should run every 5 seconds");
  }).everySeconds(5);

  // create as many jobs as you want here
}

use Human Readable intervals

everySecond
everySeconds(5)
everyMinute
everyFiveMinutes
everyMinutes(15)
everyHour
everyHours(3)
everyDay
everyDays(2)

or set using cron syntax

setRawInterval('* * * * *')

Development

# Install dependencies
npm install

# Generate type stubs
npm run dev:prepare

# Develop with the playground
npm run dev

# Build the playground
npm run dev:build

# Run ESLint
npm run lint

# Run Vitest
npm run test
npm run test:watch

# Release new version
npm run release