isBusinessDay
Checks whether a date falls on a business day (i.e. not a weekend day).
This is the logical inverse of isWeekend. By default, business days
are Monday through Friday. Pass a custom weekendDays to adapt to other
calendars.
Note: This helper does not account for public holidays — those are country- and region-specific. Use it in combination with your own holiday list if needed.
Returns false if the input is invalid.
Available since v2.0.0
Import
Section titled “Import”Signature
Section titled “Signature”Parameters
Section titled “Parameters”| Parameter | Type | Description |
|---|---|---|
date | DateLike | The date to check |
weekendDays | readonly WeekDay[] | Override which days count as weekend (default: [0, 6]) |
Returns
Section titled “Returns”boolean — true if the date is not a weekend day
Examples
Section titled “Examples”isBusinessDay
Section titled “isBusinessDay”Related Types
Section titled “Related Types”DateLike
Section titled “DateLike”A value that can be converted to a Date.
Date— used as-is (validated for Invalid Date)number— treated as a timestamp (seconds or milliseconds, auto-detected);0is treated as invalid and producesnullin ensureDatestring— parsed vianew Date(string)EpochMilliseconds— any object with aepochMillisecondsproperty (e.g.Temporal.Instant,Temporal.ZonedDateTime)
// TODO: When the Temporal API reaches Stage 4 and is available without // flags in all major runtimes, consider narrowing the union to the // concrete Temporal types for stricter type-checking.
WeekDay
Section titled “WeekDay”A day-of-week number following the JavaScript Date.getDay() convention:
0 = Sunday, 1 = Monday, … 6 = Saturday.
Prefer using WeekDays named constants for readability:
WeekDays.Monday instead of 1.
EpochMilliseconds
Section titled “EpochMilliseconds”An object that exposes an epoch timestamp in milliseconds.
This structural type is satisfied by Temporal.Instant and
Temporal.ZonedDateTime (and any future object that carries the same
property), so callers can pass Temporal values without importing them.
