Function schedule

src/node-cron.ts:52–64

(expression:string, func: TaskFn | string, options?: TaskOptions)

 * const dailyTask = schedule('0 0 * * *', './tasks/daily-backup.js', { timezone: 'America/New_York' });
 */
export function schedule(expression:string, func: TaskFn | string, options?: TaskOptions): ScheduledTask {
    const task = createTask(expression, func, options);
    // Background tasks start asynchronously and can fail (e.g. the task file
    // cannot be loaded). Route that failure to the logger instead of leaving it
    // as an unhandled rejection.
    const started = task.start();
    if (started && typeof (started as Promise<void>).catch === 'function') {
      (started as Promise<void>).catch((error: any) => {
        (options?.logger || logger).error(`Failed to start scheduled task: ${error?.message ?? error}`);
      });
    }
    return task;
}

/**
 * Creates a task instance based on the provided parameters adding it to the registry.