Skip to content
Functionplugin-tasksv0.1.0-next.1

RegisterTask

Marks a class as a task. With a cron pattern it runs on that schedule. Without one it runs when code calls schedule().

A literal pattern, timezone, or every with a mistake in it fails to compile. A cron job can't declare data since nothing passes it any.

RegisterTask<TArg, TZone, TEvery>(
    args: RegisterArgs<TArg, TZone, TEvery>
): (target: TaskTarget<TArg>) => void
\@RegisterTask('0 9 * * *', { timezone: 'America/New_York' })
export class DailyDigest extends Task {
    public async execute(): Promise<void> {}
}

TArg

TArg

TZone

TZone

TEvery

TEvery