Contents

isDateInWeekend(_:)

Indicates whether a given date falls within a weekend period, as defined by the calendar and the calendar’s locale.

Declaration

func isDateInWeekend(_ date: Date) -> Bool

Parameters

  • date:

    The date for which to perform the calculation.

Return Value

true if the given date is within a weekend period, otherwise false.

Discussion

If the date does fall within a weekend, you can use the range(ofWeekendStart:interval:containing:) method to determine the start date of that weekend period. Otherwise, you can use the nextWeekendStart(_:interval:options:after:) method to determine the start date of the next or previous weekend.

See Also

Comparing Dates