schedules

Description:

schedules

Schedules #
Manage recurring events with ease.
Features #
Create a "Schedule" for recurring events. Then, determine if that event occurs on a given date.
Great for scheduling recurring events, such as:

Paydays
Bill due dates
Birthdays
Anniversaries
Holidays

Getting started #
Install the most recent version to your app's dependencies:
dart pub add schedules
copied to clipboard
Usage #
Use one of the Schedule classes to represent a recurring event:
Singular (one-time event)
An event that occurs only once.
// One time on January 1, 2023
final singular = Singular(
date: DateTime(2023, 01, 01),
);
copied to clipboard
Daily
Repeats every n days.
// Every other day, beginning on January 1, 2023.
final daily = Daily(
startDate: DateTime(2023, 01, 01),
frequency: 2,
);
copied to clipboard
Weekly
Repeats every n weeks on the specified weekdays.
// Every other week on Monday and Thursday,
// beginning on January 1, 2023.
final weekly = Weekly(
startDate: DateTime(2023, 01, 01),
frequency: 2,
weekdays: [DateTime.monday, DateTime.thursday],
);
copied to clipboard
Monthly
Repeats every n months on the specified days.
// Every month on the 1st and 15th,
// beginning on January 1, 2023.
final monthly = Monthly(
startDate: DateTime(2023, 01, 01),
frequency: 1,
days: [1, 15],
);
copied to clipboard
Yearly
Repeats every n years on the specified date.
// Every 3 years on January 1st,
// beginning on January 1, 2023.
final yearly = Yearly(
startDate: DateTime(2023, 01, 01),
frequency: 3,
);
copied to clipboard
Occurrence #
Once you have your Schedule, you can use it to determine which dates it falls on at any point in time (after its start date).
// Every month on the 1st and 15th.
final payday = Monthly(
startDate: DateTime(2023, 01, 01),
frequency: 1,
days: [1, 15],
);

final isPayday = payday.occursOn(DateTime(2024, 06, 15)); // true
copied to clipboard