Pilgaard.CronJobs 1.0.1

Pilgaard.CronJobs

Easily schedule jobs to run at specific times, based on Cron expressions.

Installing

With NuGet:

Install-Package Pilgaard.CronJobs

With the .NET CLI:

dotnet add package Pilgaard.CronJobs

Or through Package Manager Console.

Usage

Make CronJobs by implementing ICronJob:

public class CronJob : ICronJob
{
    public Task ExecuteAsync(CancellationToken cancellationToken = default)
    {
        // Execute job

        return Task.CompletedTask;
    }

    // This will execute once every minute
    public CronExpression CronSchedule => CronExpression.Parse("* * * * *");
}

Registration

Register all CronJobs with an IServiceCollection instance:

services.AddCronJobs(typeof(Program));

This will scan the assembly for all classes that implement ICronJob, and add them to the container.

Each ICronJob found is then hosted in a CronBackgroundService.

Configuration

The following options are available for customizing ICronJob behaviour:

services.AddCronJobs(options =>
{
    options.ServiceLifetime = ServiceLifetime.Singleton;
    options.CronFormat = CronFormat.IncludeSeconds;
    options.TimeZoneInfo = TimeZoneInfo.Utc;
}, typeof(Program));

Roadmap

• More readable assembly scanning implementation
• Summaries for all the things
• Actual tests
• More (realistic) samples
  • Using Blazor
  • Using a Worker Service
  • Registering ICronJobs from an external assembly, such as a class library

Thanks to

The developers of Cronos for their excellent Cron expression library.