The identifier type for a specific day.
The identifier type for a specific month of a year.
The identifier type for a specific quarter of a year.
The identifier type for an hour of time on a specific day.
The identifier type for a specific week of a year.
The identifier type for a specific year.
Computes the identifier given values taken from a Day.
The values to compute.
The computed identifier.
Decomputes the given identifier and returns values which describe a span of time.
The identifier to decompute.
The original values which computed the identifier.
Describes the given identifier as a human friendly string.
The identifier to describe.
If the description should use shorter language or longer.
The human friendly string that describes the identifier.
Returns the identifier of this type for the given day,
The day to get the identifier of.
The identifier for the day of this type.
The length of the identifier of this type in digits.
The scales for all the different values stored in an identifier.
Determines whether the given identifier is this type.
The identifier to test.
true
if the identifier is this type, otherwise false
.
Determines if the day matches the given identifier.
The day to test.
The identifier to compare to.
true
if the day exists in the time span represented by the
identifier, otherwise false
.
Converts the given identifier which has passed Identifier.is to an object with properties pulled from the identifier.
The identifier to parse.
The object with properties parsed from the identifer.
Returns the span of time the identifier represents.
The identifier to convert to a span.
When true
the end of the span will be the very last
millisecond that represents the timespan, otherwise false
the end
will be the start of the very next span.
Returns the start of the time span the identifier represents.
The identifier to convert to a start day.
The start of the time span the identifier represents.
Determines whether the given time span outer
contains the time span
inner
.
The potentially larger time span inner
must be contained in.
The time span to test is contained inside outer
.
true
if inner
is equal to or contained in outer
, otherwise
false
.
Finds which identifier type matches the given identifier, if any.
The identifier to find the type of.
The found identifier type, otherwise null
if none exists.
Generated using TypeDoc
A class for detecting, parsing, and building identifiers to and from days.
An identifier is a simple value which represents a span of time. It may represent an entire year, a quarter (3 months) of a year, a week of a year, a month in a year, a specific day of a month of a year, or a specific hour, minute, day, and month of a year.
For example:
2018
: The year 2018201801
: January 20182014023
: The 23rd week of 201420170311
: March 11th, 2017201406151651
: June 15th 2016 at 4:51 pm'0525'
: Year 525 of the first age, Elrond and Elros are born