90 lines
4.5 KiB
Markdown
90 lines
4.5 KiB
Markdown
|
|
|
|
## 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](0.Informations.md#futureplans)
|
|
- [Compatibility & Requirements](0.Informations.md#compatibility)
|
|
- [Installation (CocoaPods,Carthage,SwiftPM](0.Informations.md#installation)
|
|
|
|
### [1 - Introduction to SwiftDate](1.Introduction.md)
|
|
|
|
- [1.0 - Dates & Cocoa](1.Introduction.md#datesandcocoa)
|
|
- [1.1 - Region & DateInRegion](1.Introduction.md#region_dateinregion)
|
|
- [1.2 - The Default Region](1.Introduction.md#default_region)
|
|
- [1.3 - Create Region](1.Introduction.md#creating_region)
|
|
- [1.4 - Create DateInRegion](1.Introduction.md#creating_dateinregion)
|
|
- [1.4.1 - From String](1.Introduction.md#initfromstring)
|
|
- [1.4.2 - From Date Components](1.Introduction.md#initfromcomponents)
|
|
- [1.4.3 - From TimeInterval](1.Introduction.md#initfromtimeinterval)
|
|
- [1.4.4 - From Date](1.Introduction.md#initfromplaindate)
|
|
|
|
### [2 - Date Parsing](2.Date_Parsing.md)
|
|
|
|
- [2.0 - Parse Custom Format](2.Date_Parsing.md#autoparsing)
|
|
- [2.1 - Parse ISO8601](2.Date_Parsing.md#iso8601)
|
|
- [2.2 - Parse .NET](2.Date_Parsing.md#dotnet)
|
|
- [2.3 - Parse RSS & AltRSS](2.Date_Parsing.md#rssaltrss)
|
|
- [2.4 - Parse SQL](2.Date_Parsing.md#sql)
|
|
|
|
### [3 - Date Manipulation & Creation](3.Manipulate_Date.md)
|
|
|
|
- [3.0 - Add & Subtract Time Units from Date](3.Manipulate_Date.md#mathdate)
|
|
- [3.1 - Get DateTime Components](3.Manipulate_Date.md#datecomponents)
|
|
- [3.2 - Get Interval Between Dates](3.Manipulate_Date.md#interval)
|
|
- [3.3 - Convert Date's Region (Locale/TimeZone/Calendar)](3.Manipulate_Date.md#convert)
|
|
- [3.4 - Rounding Date](3.Manipulate_Date.md#roundingdate)
|
|
- [3.5 - Trouncating Date](3.Manipulate_Date.md#trouncatingdate)
|
|
- [3.6 - Set Time in Date](3.Manipulate_Date.md#altertimedate)
|
|
- [3.7 - Set DateTime Components](3.Manipulate_Date.md#altercomponents)
|
|
- [3.8 - Generate Related Dates (`nextYear, nextWeeekday, startOfMonth, startOfWeek, prevMonth`...)](3.Manipulate_Date.md#relateddates)
|
|
- [3.9 - Date at start/end of time component](3.Manipulate_Date.md#startendcomponent)
|
|
- [3.10 - Enumerate Dates](3.Manipulate_Date.md#enumeratedates)
|
|
- [3.11 - Enumerate Dates for Weekday in Range](3.Manipulate_Date.md#enumerateweekdays)
|
|
- [3.12 - Random Dates](3.Manipulate_Date.md#randomdates)
|
|
- [3.13 - Sort Dates](3.Manipulate_Date.md#sort)
|
|
- [3.14 - Get the next weekday](3.Manipulate_Date.md#nextWeekDay)
|
|
- [3.15 - Get date at given week number/weekday](3.Manipulate_Date.md#dateAtWeeknumberWeekday)
|
|
- [3.16 - Difference between dates with components](3.Manipulate_Date.md#differenceBetweenDates)
|
|
- [3.17 - Create date at components preserving small components](3.Manipulate_Date.md#dateAtComponents)
|
|
- [3.18 - Date at given weekday after # weeks](3.Manipulate_Date.md#dateAfterWeeks)
|
|
- [3.19 - Next Date](3.Manipulate_Date.md#nextDate)
|
|
|
|
### [4 - Compare Dates](4.Compare_Dates.md)
|
|
|
|
- [4.0 - Compare Dates](4.Compare_Dates.md#standard)
|
|
- [4.1 - Extended Comparison with Presets (`isToday, isTomorrow, isSameWeek, isNextYear` etc.)](4.Compare_Dates.md#extended)
|
|
- [4.2 - Comparison with Granularity](4.Compare_Dates.md#granularity)
|
|
- [4.3 - Check if Date is Close to Another](4.Compare_Dates.md#close)
|
|
- [4.4 - Check if Date is Inside a Range](4.Compare_Dates.md#range)
|
|
|
|
### [5 - Date Formatting](5.Date_Formatting.md)
|
|
|
|
- [5.0 - Format Custom Style](5.Date_Formatting.md#customformatted)
|
|
- [5.1 - ISO8601 Formatted String](5.Date_Formatting.md#isoformatted)
|
|
- [5.2 - .NET Formatted String](5.Date_Formatting.md#dotnet)
|
|
- [5.3 - RSS/AltRSS Formatted String](5.Date_Formatting.md#rss)
|
|
- [5.4 - SQL Formatted String](5.Date_Formatting.md#sql)
|
|
- [5.5 - Relative/Colloquial Formatted String](5.Date_Formatting.md#colloquial)
|
|
- [5.6 - Mixed Date/Time Style](5.Date_Formatting.md#mixeddatetime)
|
|
|
|
### [6 - Time Intervals Formatting](6.TimeInterval_Formatting.md)
|
|
|
|
- [6.0 - Format Interval as String](6.TimeInterval_Formatting.md#format)
|
|
- [6.1 - Format Interval as Clock](6.TimeInterval_Formatting.md#clock)
|
|
- [6.2 - Convert TimeInterval to Time Units](6.TimeInterval_Formatting.md#express)
|
|
|
|
|
|
#### Other Links
|
|
- [7 - Unicode Table for Date Formats](7.Format_UnicodeTable.md)
|
|
- [8 - Customize Colloquial Formatter](8.Customize_ColloquialFormatter.md)
|
|
- [9 - Colloquial Formatter Supported Languages](9.ColloquialSupportedLanguages.md)
|