Skip to content

Getting started

A Nuxt module for simplifying the use of cron jobs in your project.

Installation

  1. Install nuxt-cron to your dependencies.
bash
pnpm add nuxt-cron -D
bash
npm install nuxt-cron -D
bash
yarn add nuxt-cron -D
  1. Add nuxt-cron to the modules section of your config file.
ts
// nuxt.config.ts
export default defineNuxtConfig({
  modules: ['nuxt-cron']
})

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

Options

You can configure the module by adding a nuxt-cron section to your nuxt.config file. read more about cron options.

ts
// nuxt.config.ts
export default defineNuxtConfig({
  cron: {
    // Options
  }
})