ts-time-format/DateFormatter

import DateFormatter, {DateCompiler, DATE_COMPILERS, ERA_COMPILER, YEAR_COMPILER, YEAR_OF_ERA_COMPILER, DAY_OF_YEAR_COMPILER, MONTH_COMPILER, DAY_OF_MONTH_COMPILER, QUARTER_OF_YEAR_COMPILER, WEEK_BASED_YEAR_COMPILER, WEEK_OF_WEEK_BASED_YEAR_COMPILER, DAY_OF_WEEK_TEXT_COMPILER, DAY_OF_WEEK_COMPILER} from "ts-time-format/DateFormatter";

Hierarchy#

• class TemporalFormatter<T>
• class DateFormatter

Description#

Formatter of LocalDate to a string. You may initialize a formatter explicitly by using of method, or implicitly by using ofPattern method. See DATE_COMPILERS for supported pattern characters. See parsePattern for general pattern writing guidelines.

Methods#

format (inherited from TemporalFormatter)#

Static methods#

of#

ofPattern#

Hierarchy#

• interface TemporalCompiler<T>
• interface DateCompiler

Description#

TemporalCompiler for LocalDate.

Fields#

maxLength (inherited from TemporalCompiler)#

Methods#

compile (inherited from TemporalCompiler)#

DATE_COMPILERS: Dictionary<DateCompiler>

Default dictionary from pattern character to the respective compiler:

Character	Compiler	Examples per length
		1	2	3	4	5
G	ERA_COMPILER	AD	Anno Domini	A
u	YEAR_COMPILER	2009	09	2009	2009
y	YEAR_OF_ERA_COMPILER	2009	09	2009	2009
D	DAY_OF_YEAR_COMPILER	5	05	005
M or L	MONTH_COMPILER	2	02	Feb	February	F
d	DAY_OF_MONTH_COMPILER	5	05
Q or q	QUARTER_OF_YEAR_COMPILER	1	01	Q1	1st quarter
Y	WEEK_BASED_YEAR_COMPILER	2009	09	2009	2009
w	WEEK_OF_WEEK_BASED_YEAR_COMPILER	5	05
E	DAY_OF_WEEK_TEXT_COMPILER	Tue	Tuesday	T
e or c	DAY_OF_WEEK_COMPILER	2	02	Tue	Tuesday	T

ERA_COMPILER: DateCompiler

Depending on length:

1. Writes context.eraShortNames[date.era.value] (default to "BC", "AD")
2. Writes context.eraNames[date.era.value] (default to "Before Christ", "Anno Domini")
3. Writes context.eraAbbreviations[date.era.value] (default to "B", "A")

Default pattern character is "G".

YEAR_COMPILER: DateCompiler

Depending on length:

1. Writes String(date.year).
2. Writes two lower-rank digits of date.year. For example, writes "09" for 2009 year. Includes sign for BC, e.g. "-09" for -9 year.
3. Same as 1.
4. Same as 1.

Default pattern character is "u".

YEAR_OF_ERA_COMPILER: DateCompiler

Same as YEAR_COMPILER, but based on date.yearOfEra. See Era for year convertion rules.

Default pattern character is "y".

DAY_OF_YEAR_COMPILER: DateCompiler

Depending on length:

1. Writes String(date.dayOfYear).
2. or 3. Writes date.dayOfYear, prepending it with leading zeros if necessary to ensure 2/3 digits. For example, writes "023" for 23rd of January and length 3.

Default pattern character is "D".

MONTH_COMPILER: DateCompiler

Depending on length:

1. Writes String(date.month.value).
2. Writes date.month.value, prepending it with a leading zero if necessary to ensure 2 digits. For example, writes "02" for February.
3. Writes context.monthShortNames[date.month.value - 1] (default to "Jan", "Feb"...)
4. Writes context.monthNames[date.month.value - 1] (default to "January", "February"...)
5. Writes context.monthAbbreviations[date.month.value - 1] (default to "J", "F"...)

Default pattern character is "M" or "L".

DAY_OF_MONTH_COMPILER: DateCompiler

Depending on length:

1. Writes String(date.dayOfMonth).
2. Writes date.dayOfMonth, prepending it with a leading zero if necessary to ensure 2 digits. For example, writes "06" for 6th of February.

Default pattern character is "d".

QUARTER_OF_YEAR_COMPILER: DateCompiler

Depending on length:

1. Writes String(date.quarterOfYear).
2. Writes date.quarterOfYear, prepending it with a leading zero to ensure 2 digits. For example, writes "04" for 4th quarter.
3. Writes context.quarterShortNames[date.quarterOfYear - 1] (default to "Q1", "Q2"...)
4. Writes context.quarterNames[date.quarterOfYear - 1] (default to "1st quarter", "2nd quarter"...)

Default pattern character is "Q" or "q".

WEEK_BASED_YEAR_COMPILER: DateCompiler

Same as YEAR_COMPILER, but based on date.weekBasedYear.

Default pattern character is "Y".

WEEK_OF_WEEK_BASED_YEAR_COMPILER: DateCompiler

Depending on length:

1. Writes String(date.weekOfWeekBasedYear).
2. Writes date.weekOfWeekBasedYear, prepending it with a leading zero if necessary to ensure 2 digits. For example, writes "09" for 9th week of year.

Default pattern character is "w".

DAY_OF_WEEK_TEXT_COMPILER: DateCompiler

Depending on length:

1. Writes context.dayOfWeekShortNames[date.dayOfWeek.value - 1] (default to "Mon", "Tue"...)
2. Writes context.dayOfWeekNames[date.dayOfWeek.value - 1] (default to "Monday", "Tuesday"...)
3. Writes context.dayOfWeekAbbreviations[date.dayOfWeek.value - 1] (default to "M", "T")

Default pattern character is "E".

DAY_OF_WEEK_COMPILER: DateCompiler

Depending on length:

1. Writes String(date.dayOfWeek.value).
2. Writes date.dayOfWeek.value, prepending it with a leading zero to ensure 2 digits. For example, writes "04" for Thursday.
3. or 4. or 5. Same as DAY_OF_WEEK_TEXT_COMPILER's 1, 2 and 3 respectively.

Default pattern character is "e" or "c".