Skip to content

HolidayCalendar

type HolidayCalendar =
| HolidayPredicate
| Iterable<string | number | Date>;

Defined in: packages/engine/src/constants/Configuration.ts:49

The host-supplied public-holiday calendar, in the same “bring your own data” shape the stocks and weather packages already use for a host callback (see packages/stocks/StocksPackage.ts): weekends are decidable from the date alone, holidays are not, so they come from the host or not at all.

Either a HolidayPredicate, for a host that computes holidays itself (an existing library, a region rule), or an iterable of specific dates as YYYY-MM-DD strings, epoch-millisecond numbers or Date objects, for a host that just has a list. Resolved to one internal predicate by vm/HolidayCalendar.ts’s resolveHolidayPredicate().

Left unset, working-day arithmetic skips weekends only, which is the honest default: the engine excludes exactly the days it can prove are non-working.