Schedule Jobs within Nuxt 3.
This is a Server-Side task scheduler for Nuxt which depends on node-cron.
- 👩🏼🌾 human readable
- 😌 easy to use
- Add
nuxt-schedulerdependency 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- Add
nuxt-schedulerto themodulessection ofnuxt.config.ts
export default defineNuxtConfig({
modules: [
'nuxt-scheduler'
]
})That's it! You can now use Nuxt Scheduler in your Nuxt app ✨
Create as many scheduler you like as plugins.
~/server/plugins/smileScheduler.ts
import { useScheduler } from "#scheduler"
import say from "~~/server/app/services/say";
export default defineNitroPlugin(() => {
startScheduler()
})
function startScheduler() {
const scheduler = useScheduler();
scheduler.run(() => {
say("cool beans! I run once a second! 😀");
}).everySecond();
// create as many tasks as you want here
}Each scheduler can have multiple tasks
~/server/plugins/rocketScheduler.ts
import { useScheduler } from "#scheduler"
import say from "~~/server/app/services/say";
export default defineNitroPlugin(() => {
startScheduler()
})
function startScheduler() {
const scheduler = useScheduler();
scheduler.run(() => {
say("I run every 3 seconds, 🚀🚀🚀");
}).everySeconds(3);
scheduler.run(() => {
say("I run every 5 seconds, 🚀🚀🚀🚀🚀");
}).everySeconds(5);
// create as many tasks as you want here
}use Human Readable intervals
everySecond
everySeconds
everyMinute
everyMinutes
everyTwoMinutes
everyThreeMinutes
everyFourMinutes
everyFiveMinutes
everyTenMinutes
everyFifteenMinutes
everyThirtyMinutes
hourly
hourlyAt
everyOddHour
everyHours
everyTwoHours
everyThreeHours
everyFourHours
everySixHours
daily
dailyAt
everyDays
weekly
quarterly
yearly
or set using cron method
cron() method accepts 'optional' string parameter called timezone where you have to pass a valid string values eg. Asia/Shanghai, Asia/Kolkata, America/Sao_Paulo refer IANA time zone database for same.
import { useScheduler } from "#scheduler"
import say from "~~/server/app/services/say";
export default defineNitroPlugin(() => {
startScheduler()
})
function startScheduler() {
const scheduler = useScheduler();
scheduler.run(() => {
say("I run once a second! 🚀");
}).cron('* * * * *');
scheduler.run(() => {
say("Running a job at 01:00 PM at America/Sao_Paulo timezone 🌍");
}).cron('0 13 * * *', 'America/Sao_Paulo');
// create as many tasks as you want here
}to prevent the scheduler from running during the build, you can do the following
update the build command to add a new environment variable
"scripts": {
"build": "APP_ENV=build nuxt build",
}then in your scheduler plugin, you can check for the environment variable
import { useScheduler } from "#scheduler"
export default defineNitroPlugin(() => {
//early return if build context
if (process.env.APP_ENV === 'build') {
console.log('[server/plugins/scheduler.ts] Skipping scheduler, in build context');
return;
}
startScheduler()
})
function startScheduler() {
const scheduler = useScheduler();
scheduler.run(() => {
console.log("cool beans! I run once a second! 😀");
}).everySecond();
// create as many tasks as you want here
}# 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 releaseSpecial thanks to Atinux for making suggestions that have made this module better 🚀
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent