Skip to content

DatesServiceTypes

katanakit-js / 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.

useAddDays(date, days): string;

Defined in: types/core/dates.ts:47

Parameter Type
date string | PlainDate
days number

string


useDateAdd(
date,
amount,
unit
): string;

Defined in: types/core/dates.ts:41

Parameter Type
date TemporalInput
amount number
unit "years" | "quarters" | "months" | "weeks" | "days" | "hours" | "minutes"

string


useDateBetween(
start,
end,
unit?
): number;

Defined in: types/core/dates.ts:39

Parameter Type
start TemporalInput
end TemporalInput
unit? "years" | "quarters" | "months" | "weeks" | "days" | "hours" | "minutes"

number


useDateOrder(date1, date2): "before" | "after" | "same";

Defined in: types/core/dates.ts:43

Parameter Type
date1 TemporalInput
date2 TemporalInput

"before" | "after" | "same"


useDateSubtract(
date,
amount,
unit
): string;

Defined in: types/core/dates.ts:42

Parameter Type
date TemporalInput
amount number
unit "years" | "quarters" | "months" | "weeks" | "days" | "hours" | "minutes"

string


useDurationBetween(start, end): Duration;

Defined in: types/core/dates.ts:40

Parameter Type
start TemporalInput
end TemporalInput

Duration


useFirstDayOfMonth(date?): string;

Defined in: types/core/dates.ts:52

Parameter Type
date? string | PlainDate

string


useFormat(
dateInput,
locale?,
options?
): string;

Defined in: types/core/dates.ts:44

Parameter Type
dateInput TemporalInput
locale? "en" | "es" | "fr" | "de" | "it" | "pt" | "ja" | "zh"
options? DateTimeFormatOptions

string


useIsAfter(date1, date2): boolean;

Defined in: types/core/dates.ts:51

Parameter Type
date1 string | PlainDate
date2 string | PlainDate

boolean


useIsBefore(date1, date2): boolean;

Defined in: types/core/dates.ts:50

Parameter Type
date1 string | PlainDate
date2 string | PlainDate

boolean


useIsEqual(date1, date2): boolean;

Defined in: types/core/dates.ts:49

Parameter Type
date1 string | PlainDate
date2 string | PlainDate

boolean


useLastDayOfMonth(date?): string;

Defined in: types/core/dates.ts:53

Parameter Type
date? string | PlainDate

string


useNow(): string;

Defined in: types/core/dates.ts:45

string


useNowDateTime(): string;

Defined in: types/core/dates.ts:46

string


useSubtractDays(date, days): string;

Defined in: types/core/dates.ts:48

Parameter Type
date string | PlainDate
days number

string