Node.js - schedule()

Creates a new Schedule to run a function on a defined frequency.

import { schedule } from '@nitric/sdk'

// Create a schedule that runs every 3 hours
schedule('aggregate-data').every('3 hours', async (ctx) => {
  console.log('do something here')
})

Parameters

Name
description
Required
Required
Type
string
Description
The unique name of this Schedule within the app. Subsequent calls to schedule with the same name will return the same object.

Notes

Schedules do not require access permissions to be specified.
During local development schedules can be triggered manually from the local development dashboard

Examples

Create a Schedule

import { schedule } from '@nitric/sdk'

schedule('send-reminders').every('3 minutes', async (ctx) => {
  // add code to run here
})

schedule('archive-orders').cron('0 1 1 * *', async (ctx) => {
  // add code to run here
})

Edit this page on GitHub

Last updated on May 20, 2025