Contents

year()

Modifies the date interval format style to include the year.

Declaration

func year() -> Date.IntervalFormatStyle

Return Value

A date interval format style that includes the year.

Discussion

Use a combination of modifier instance methods to customize the format of the date interval. The following example shows several combinations of year, month, and day components in the date interval:

if let today = Calendar.current.date(byAdding: .day, value: -140, to: Date()),
   let sevenDaysBeforeToday = Calendar.current.date(byAdding: .day, value: -7, to: today) {

    // Create a Range<Date>.
    let weekBefore = sevenDaysBeforeToday..<today

    print(weekBefore.formatted(.interval))
    print(weekBefore.formatted(.interval.day()))
    print(weekBefore.formatted(.interval.day().month(.defaultDigits)))
    print(weekBefore.formatted(.interval.day().month(.wide).year()))
}
// 2/5/21, 6:37 AM – 2/12/21, 6:37 AM
// 5 – 12
// 2/5 – 2/12
// February 5 – 12, 2021

See Also

Modifying Date Interval Format Styles