DatesServiceTypes
katanakit-js / DatesServiceTypes
Interface: DatesServiceTypes
Section titled “Interface: DatesServiceTypes”Defined in: types/core/dates.ts:38
Contract of the dates facade.
useDateBetween, useDateAdd, useDateSubtract and useDateOrder are the
arithmetic primitives; useDurationBetween is the structured breakdown.
Methods
Section titled “Methods”useAddDays()
Section titled “useAddDays()”useAddDays(date, days): string;Defined in: types/core/dates.ts:47
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
date |
string | PlainDate |
days |
number |
Returns
Section titled “Returns”string
useDateAdd()
Section titled “useDateAdd()”useDateAdd( date, amount, unit): string;Defined in: types/core/dates.ts:41
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
date |
TemporalInput |
amount |
number |
unit |
"years" | "quarters" | "months" | "weeks" | "days" | "hours" | "minutes" |
Returns
Section titled “Returns”string
useDateBetween()
Section titled “useDateBetween()”useDateBetween( start, end, unit?): number;Defined in: types/core/dates.ts:39
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
start |
TemporalInput |
end |
TemporalInput |
unit? |
"years" | "quarters" | "months" | "weeks" | "days" | "hours" | "minutes" |
Returns
Section titled “Returns”number
useDateOrder()
Section titled “useDateOrder()”useDateOrder(date1, date2): "before" | "after" | "same";Defined in: types/core/dates.ts:43
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
date1 |
TemporalInput |
date2 |
TemporalInput |
Returns
Section titled “Returns”"before" | "after" | "same"
useDateSubtract()
Section titled “useDateSubtract()”useDateSubtract( date, amount, unit): string;Defined in: types/core/dates.ts:42
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
date |
TemporalInput |
amount |
number |
unit |
"years" | "quarters" | "months" | "weeks" | "days" | "hours" | "minutes" |
Returns
Section titled “Returns”string
useDurationBetween()
Section titled “useDurationBetween()”useDurationBetween(start, end): Duration;Defined in: types/core/dates.ts:40
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
start |
TemporalInput |
end |
TemporalInput |
Returns
Section titled “Returns”Duration
useFirstDayOfMonth()
Section titled “useFirstDayOfMonth()”useFirstDayOfMonth(date?): string;Defined in: types/core/dates.ts:52
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
date? |
string | PlainDate |
Returns
Section titled “Returns”string
useFormat()
Section titled “useFormat()”useFormat( dateInput, locale?, options?): string;Defined in: types/core/dates.ts:44
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
dateInput |
TemporalInput |
locale? |
"en" | "es" | "fr" | "de" | "it" | "pt" | "ja" | "zh" |
options? |
DateTimeFormatOptions |
Returns
Section titled “Returns”string
useIsAfter()
Section titled “useIsAfter()”useIsAfter(date1, date2): boolean;Defined in: types/core/dates.ts:51
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
date1 |
string | PlainDate |
date2 |
string | PlainDate |
Returns
Section titled “Returns”boolean
useIsBefore()
Section titled “useIsBefore()”useIsBefore(date1, date2): boolean;Defined in: types/core/dates.ts:50
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
date1 |
string | PlainDate |
date2 |
string | PlainDate |
Returns
Section titled “Returns”boolean
useIsEqual()
Section titled “useIsEqual()”useIsEqual(date1, date2): boolean;Defined in: types/core/dates.ts:49
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
date1 |
string | PlainDate |
date2 |
string | PlainDate |
Returns
Section titled “Returns”boolean
useLastDayOfMonth()
Section titled “useLastDayOfMonth()”useLastDayOfMonth(date?): string;Defined in: types/core/dates.ts:53
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
date? |
string | PlainDate |
Returns
Section titled “Returns”string
useNow()
Section titled “useNow()”useNow(): string;Defined in: types/core/dates.ts:45
Returns
Section titled “Returns”string
useNowDateTime()
Section titled “useNowDateTime()”useNowDateTime(): string;Defined in: types/core/dates.ts:46
Returns
Section titled “Returns”string
useSubtractDays()
Section titled “useSubtractDays()”useSubtractDays(date, days): string;Defined in: types/core/dates.ts:48
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
date |
string | PlainDate |
days |
number |
Returns
Section titled “Returns”string