SwiftDate/Documentation/Index.md

Documentation

• Reference Version: 6.1.0
• Last Update: **Sept 2020

The following documentation explores all the major features of the library. If you are interested in a detailed, method by method documentation you can refeer to the Jazzy documentation generated by CocoaPods (you can also install in Dash).

Table Of Contents

[0 - Info & Install]

• Future Plans
• Compatibility & Requirements
• Installation (CocoaPods,Carthage,SwiftPM

1 - Introduction to SwiftDate

• 1.0 - Dates & Cocoa
• 1.1 - Region & DateInRegion
• 1.2 - The Default Region
• 1.3 - Create Region
• 1.4 - Create DateInRegion
  • 1.4.1 - From String
  • 1.4.2 - From Date Components
  • 1.4.3 - From TimeInterval
  • 1.4.4 - From Date

2 - Date Parsing

• 2.0 - Parse Custom Format
• 2.1 - Parse ISO8601
• 2.2 - Parse .NET
• 2.3 - Parse RSS & AltRSS
• 2.4 - Parse SQL

3 - Date Manipulation & Creation

• 3.0 - Add & Subtract Time Units from Date
• 3.1 - Get DateTime Components
• 3.2 - Get Interval Between Dates
• 3.3 - Convert Date's Region (Locale/TimeZone/Calendar)
• 3.4 - Rounding Date
• 3.5 - Trouncating Date
• 3.6 - Set Time in Date
• 3.7 - Set DateTime Components
• 3.8 - Generate Related Dates (nextYear, nextWeeekday, startOfMonth, startOfWeek, prevMonth...)
• 3.9 - Date at start/end of time component
• 3.10 - Enumerate Dates
• 3.11 - Enumerate Dates for Weekday in Range
• 3.12 - Random Dates
• 3.13 - Sort Dates
• 3.14 - Get the next weekday
• 3.15 - Get date at given week number/weekday
• 3.16 - Difference between dates with components
• 3.17 - Create date at components preserving small components
• 3.18 - Date at given weekday after # weeks
• 3.19 - Next Date

4 - Compare Dates

• 4.0 - Compare Dates
• 4.1 - Extended Comparison with Presets (isToday, isTomorrow, isSameWeek, isNextYear etc.)
• 4.2 - Comparison with Granularity
• 4.3 - Check if Date is Close to Another
• 4.4 - Check if Date is Inside a Range

5 - Date Formatting

• 5.0 - Format Custom Style
• 5.1 - ISO8601 Formatted String
• 5.2 - .NET Formatted String
• 5.3 - RSS/AltRSS Formatted String
• 5.4 - SQL Formatted String
• 5.5 - Relative/Colloquial Formatted String
• 5.6 - Mixed Date/Time Style

6 - Time Intervals Formatting

• 6.0 - Format Interval as String
• 6.1 - Format Interval as Clock
• 6.2 - Convert TimeInterval to Time Units

Other Links

• 7 - Unicode Table for Date Formats
• 8 - Customize Colloquial Formatter
• 9 - Colloquial Formatter Supported Languages