date

This modules provides Blade's implementation of date and time manipulation methods. This module implements civil dates as well as julian dates.

Definitions

• The calendar date (class Date) is a particular day of a calendar year, identified by its ordinal number within a calendar month within that year.

• The Julian date number (jd) is in elapsed days and time since noon (Greenwich Mean Time) on January 1, 4713 BCE (in the Julian calendar).

Properties

• MIN_YEAR ⇢ number:

  Minimum year supported.

• MAX_YEAR ⇢ number:

  Maximum year supported.

• MIN_DAY ⇢ number:

  Minimum day supported.

• MAX_DAY ⇢ number:

  Maximum day supported.

• MIN_MONTH ⇢ number:

  Minimum month supported.

• MAX_MONTH ⇢ number:

  Maximum year supported.

• MAX_HOUR ⇢ number:

  Maximum hour supported.

• MAX_MINUTE ⇢ number:

  Maximum minute supported.

• MAX_SECONDS ⇢ number:

  Maximum seconds supported.

Functions

gmtime()

Returns a dictionary representing the current time without timezone adjustment.

Example,

%> echo date.gmtime()
{year: 2022, month: 3, day: 5, week_day: 6, year_day: 63, hour: 17, minute: 30, 
seconds: 55, microseconds: 620290, is_dst: false, zone: UTC, gmt_offset: 0}

Returns

• dictionary

localtime()

Returns a dictionary representing the current time after adjusting for the current timezone

Example:

%> echo date.localtime()
{year: 2022, month: 3, day: 5, week_day: 6, year_day: 63, hour: 18, minute: 18, 
seconds: 35, microseconds: 598166, is_dst: false, zone: WAT, gmt_offset: 3600}

Returns

• dictionary

mktime(year, month, day, hour, minute, seconds, is_dst)

Convert the broken-out time into a time value with the same encoding as that of the values returned by the time() function (that is, seconds from the Epoch, UTC) according to the timezone settings.

%> import date
%> echo date.mktime(2021, 2, 12, 13, 43, 11, false)
1613133791

Parameters

• number year
• number month
• number day
• number hour
• number minute
• number seconds
• bool is_dst

Returns

• number

from_time(time)

Returns a date object from a unix timestamp.

Example,

%> to_string(date.from_time(time()))
'<Date year: 2022, month: 3, day: 5, hour: 18, minute: 34, seconds: 1>'

Parameters

• number time

Returns

• Date

Notes

• Time must be in seconds.

from_jd(jdate)

Returns a date instance representing the julian date.

Example,

%> to_string(date.from_jd(22063))
'<Date year: 2022, month: 3, day: 5, hour: 18, minute: 35, seconds: 0>'

Parameters

• number jdate

Returns

• number

date(year, month, day, hour, minute, seconds) ⇢ Exported

Returns a new Date instance representing the given system date or the current date if no argument is specified.

Parameters

• number? year
• number? month
• number? day
• number? hour
• number? minute
• number? seconds
• bool? is_dst

Returns

• Date

Classes

class Date

Date and Time manipulation class

A date here refers to a calendar datetime consisting of year, month, day, hour, minute and seconds.

The Date class manages both Date and DateTime and this module does not make any distinction between the two as Date is a subset of DateTime.

Example,

%> import date
%> var d = date(2021)
%> to_string(d)
'<Date year: 2021, month: 1, day: 1, hour: 0, minute: 0, seconds: 0>'
%> d = date()
%> to_string(d)
'<Date year: 2022, month: 3, day: 5, hour: 19, minute: 25, seconds: 58>'

Properties

• @printable
• @serializable

Methods

Date(year, month, day, hour, minute, seconds, microseconds) ⇢ Constructor

Parameters

• number? year
• number? month
• number? day
• number? hour
• number? minute
• number? seconds
• number? microseconds
• bool? is_dst

Notes

• All arguments are optional
• When no argument is given, the date will be set to the current system date.

is_leap()

Returns true if the year is a leap year or false otherwise.

Example,

%> date(2018).is_leap()
false
%> date(2020).is_leap()
true

Returns

• bool

days_before_month(month)

Returns the number of days in the year preceeding the first day of the month.

Example,

%> date(2021, 5, 11).days_before_month(7)
142

Returns

• number

days_before_year(year)

Returns the number of days before January 1st of year.

Example,

%> date(2021, 5, 11).days_before_year(2024)
811

Parameters

• int year

Returns

• number

days_in_month()

Returns the number of days in month for the specified year.

Example,

%> date(2021, 6).days_in_month()
30

Returns

• number

weekday()

Returns the numbered day of the week.

Example,

%> date(2021, 5, 11).weekday()
2

Returns

• number

week_number()

Returns the number of the current week in the year.

Example,

%> date(2021, 5, 11).week_number()
19

Returns

• number

format(format)

Formats the current date based on the specified string

Blade's Date formatting table

Example,

%> date().format('F d, Y g:i A')
'March 05, 2022 6:24 PM'

You can prevent a format character in the format string from being expanded by escaping it with a preceding backslash. If the character with a backslash is already a special sequence, you may need to also escape the backslash.

For example:

%> date().format('l jS \o\\f F Y h:i:s A')
'Wednesday 17th of May 2021 01:39:08 PM'

Parameters

• string format

Returns

• string

http()

Returns the HTTP date representation of the current date.

For example,

%> date().http()
'Sat, 05 Mar 2022 06:23:32 GMT'

Returns

• string

jd()

Converts the current date to a julian day and time.

Example,

%> date(2021, 5, 11).jd()
2459345

Returns

• number

unix_time()

@deprecated: - Use to_time() instead as it offers more precision.

Returns unix mktime equivalent of the current date.

@deprecated - Use to_time() instead as it offers more precision.

Returns

• number

to_time()

Returns the Epoch timestamp in seconds for the given date.

Returns

• number

to_string()

Returns a string representation of the date

Returns

• string

to_dict()

Returns the date object as a dictionary.

Returns

• dict