Current version 1.0.0: DateTime.rbxm (11,1 KB)
About this module
This is a basic DateTime module that represents a date and a time, it doesn’t use os.date, and it can represent dates from 1 January 1 CE to 31 December 99999, it’s stored as if the time zone is UTC.
Why DateTime and TimeSpan if I’ve already got os.date?
This module has features os.date doesn’t have like addings days, months, and years, formatting etc.
This module is more convient when you want to add months/years of a date, as doing DateTime.new(2016, 2, 29):AddYears(1) will return DateTime.new(2017, 2, 28) but doing DateTime.new(2016, 2, 29):AddYears(4) will return DateTime.new(2020, 2, 29).
Features
It supports comparing dates
local dt1 = DateTime.DateTime.new(2000, 1, 2);
local dt2 = DateTime.DateTime.new(1999, 12, 31);
print(dt1 > dt2);
print(dt1 >= dt2);
print(dt1 < dt2);
print(dt1 == dt2)
dt2 = DateTime.DateTime.new(2000, 1, 2);
print(dt1 >= dt2);
print(dt1 == dt2);
true
true
false
false
true
true
and, adding and subtracting them
local dt1 = DateTime.DateTime.new(2000, 12, 30, 2, 42, 57);
local dt2 = DateTime.DateTime.new(1996, 5, 5, 1, 46, 39);
local ts1 = DateTime.TimeSpan.new(5, 11, 14, 17);
print(dt1 + ts1)
print(dt1 - ts1)
print(dt1 - dt2)
2001-01-04 13:57:14
2000-12-24 15:28:40
1700,00:56:18
Here are the list of operators supported in DateTime and TimeSpan module:
DateTime - DateTime = TimeSpan
DateTime - TimeSpan = DateTime
DateTime + TimeSpan = DateTime
TimeSpan + TimeSpan = TimeSpan
TimeSpan - TimeSpan = TimeSpan
TimeSpan * Integer = TimeSpan
TimeSpan / Integer = TimeSpan
It can also format dates
local dt1 = DateTime.DateTime.FromEpoch(1234567890);
print(dt1:Format('F'));
Friday, 13 February 2009 23:31:30
local dt1 = DateTime.DateTime.new(2017, 6, 11);
print(dt1:Format('MMMM d, y'))
June 11, 2017
Only the formatting date and time is appealing to me
Is it possible to format os.date?
Yes it is possible to format os.date and it’s simple actually, just convert it to DateTime
function FormatOsDate(t, format, dtfi)
return DateTime.DateTime.FromOsDate(t):Format(format, dtfi)
end;
print(FormatOsDate(os.date('!*t', 1234567890), 'F'))
Friday, 13 February 2009 23:31:30
Patterns
It’ll check the basic first, if the format value doesn’t fit into basic, it’ll go to custom.
DateTime
Basic
| Format | Description |
|---|---|
| d | Short date pattern |
| D | Long date pattern |
| f | Full date/time pattern (short time) |
| F | Full date/time pattern (long time) |
| g | General date/time pattern (short time) |
| G | General date/time pattern (short time) |
| m M | Month day pattern |
| y Y | Year month pattern |
| t | Short time pattern |
| T | Long time pattern |
Custom
| Format specifier | Description | Example |
|---|---|---|
| a aa | The AM/PM designator. | 01:02:03 → AM; 13:45:30 → PM |
| d | Day of the month from 1 to 31 | 1987-06-05 01:04:07 → 5 |
| dd | Day of the month from 01 to 31 | 1987-06-05 01:04:07 → 05 |
| E EE EEE | The abbreviated name for the day of the week | 1987-06-05 → Fri |
| EEEE | The full name for the day of the week | 1987-06-05 → Friday |
| h | The hour using 12-hour clock | 13:45:30 → 1; 01:02:03 → 1 |
| hh | The hour using 12-hour clock | 13:45:30 → 01; 01:02:03 → 01 |
| H | The hour using 24-hour clock | 13:45:30 → 13; 01:02:03 → 1 |
| HH | The hour using 24-hour clock | 13:45:30 → 13; 01:02:03 → 01 |
| m | The minute from 0 to 59 | 01:02:03 → 2 |
| mm | The minute from 00 to 59 | 01:02:03 → 02 |
| M | The month from 1 to 12 | 1987-06-05 01:04:07 → 6 |
| MM | The month from 01 to 12 | 1987-06-05 01:04:07 → 06 |
| MMM | The abbreviated name for the month | 1987-06-05 01:04:07 → Jun |
| MMMM | The full name for the month | 1987-06-05 01:04:07 → June |
| s | The second from 1 to 12 | 01:02:03 → 3 |
| ss | The second from 01 to 12 | 01:02:03 → 03 |
| y | The full year | 1987-06-05 01:04:07 → 1987; 0012-03-04 → 12 |
| yy | The year from 00 to 99 | 1987-06-05 01:04:07 → 87; 2001-02-03 → 01 |
| yyy | The year as 3 minimum digit | 1987-06-05 01:04:07 → 1987; 0012-03-04 → 012 |
| yyyy | The year as 4 minimum digit | 1987-06-05 01:04:07 → 1987; 0012-03-04 → 0012 |
| ’ | Literal string delimiter. '' for literal '
|
1987-06-05 ('year' y, 'month' m, 'day' d) → year 1987, month 6, day 5 |
| / | Date separator | 1987-06-05 (dd/MM/y, DateTimeFormatInfo.Preset.de) → 05.06.1987 |
| : | Time separator | 01:04:07 (HH:mm:ss, DateTimeFormatInfo.Preset.da) → 01.04.07 |
TimeSpan
Basic
| Format | Description |
|---|---|
| dhms | Day hour minute second pattern |
| hms | Hour minute second pattern |
| hmsf | Hour minute second millisecond pattern |
| ms | Minute second pattern |
| msf | Minute second millisecond pattern |
| sf | Second millisecond pattern |
| adhms | Abbreivated day hour minute second pattern |
| ahms | Abbreivated hour minute second pattern |
| ahmsf | Abbreivated hour minute second millisecond pattern |
| amsf | Abbreivated minute second pattern |
| amsf | Abbreivated minute second millisecond pattern |
| asf | Abbreivated second millisecond pattern |
| fdhms | Full day hour minute second pattern |
| fhms | Full hour minute second pattern |
| fhmsf | Full hour minute second millisecond pattern |
| fmsf | Full minute second pattern |
| fmsf | Full minute second millisecond pattern |
| fsf | Full second millisecond pattern |
Custom
Format specifier|Description
-|-|-
d %d|Number of whole day in time interval
dd - dddddddd|Number of whole day in time interval with padding zeros as needed
h %h|Whole hours that aren’t counted as days
hh|Whole hours that aren’t counted as days that are zero padded
m %m|Whole minutes that aren’t counted as hours
mm|Whole minutes that aren’t counted as hours that are zero padded
s %s|Whole seconds that aren’t counted as minutes
ss|Whole seconds that aren’t counted as minutes that are zero padded
:|Time separator
,|Millisecond separator
What are DateTimeFormatInfo and TimeSpanFormatInfo?
These are for getting the month, the day names, the time separator and the date separator in DateTime.Format and the time separator and the milliseconds separator in TimeSpan.Format
Example:
local dtfi = DateTime.DateTimeFormatInfo.new
{
TimeSeparator = '.';
DateSeparator = '/';
};
local dt = DateTime.DateTime.new(1987, 6, 5, 4, 3, 2);
print(dt:Format('F', dtfi))
1987 M06 5 04.03.02
More parts will be documented later
!