katanakit-js / DatesServiceTypes

Interface: DatesServiceTypes

Defined in: src/types/index.ts:354

Contract of the dates facade.

useDateBetween, useDateAdd, useDateSubtract and useDateOrder are the arithmetic primitives; useDurationBetween is the structured breakdown.

Methods

useAddDays()

useAddDays(date, days): string;

Defined in: src/types/index.ts:363

Parameters

Parameter	Type
date	string | PlainDate
days	number

Returns

string

---

useDateAdd()

useDateAdd(
   date, 
   amount, 
   unit
): string;

Defined in: src/types/index.ts:357

Parameters

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

Returns

string

---

useDateBetween()

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

Defined in: src/types/index.ts:355

Parameters

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

Returns

number

---

useDateOrder()

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

Defined in: src/types/index.ts:359

Parameters

Parameter	Type
date1	TemporalInput
date2	TemporalInput

Returns

"before" | "after" | "same"

---

useDateSubtract()

useDateSubtract(
   date, 
   amount, 
   unit
): string;

Defined in: src/types/index.ts:358

Parameters

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

Returns

string

---

useDurationBetween()

useDurationBetween(start, end): Duration;

Defined in: src/types/index.ts:356

Parameters

Parameter	Type
start	TemporalInput
end	TemporalInput

Returns

Duration

---

useFirstDayOfMonth()

useFirstDayOfMonth(date?): string;

Defined in: src/types/index.ts:368

Parameters

Parameter	Type
date?	string | PlainDate

Returns

string

---

useFormat()

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

Defined in: src/types/index.ts:360

Parameters

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

Returns

string

---

useIsAfter()

useIsAfter(date1, date2): boolean;

Defined in: src/types/index.ts:367

Parameters

Parameter	Type
date1	string | PlainDate
date2	string | PlainDate

Returns

boolean

---

useIsBefore()

useIsBefore(date1, date2): boolean;

Defined in: src/types/index.ts:366

Parameters

Parameter	Type
date1	string | PlainDate
date2	string | PlainDate

Returns

boolean

---

useIsEqual()

useIsEqual(date1, date2): boolean;

Defined in: src/types/index.ts:365

Parameters

Parameter	Type
date1	string | PlainDate
date2	string | PlainDate

Returns

boolean

---

useLastDayOfMonth()

useLastDayOfMonth(date?): string;

Defined in: src/types/index.ts:369

Parameters

Parameter	Type
date?	string | PlainDate

Returns

string

---

useNow()

useNow(): string;

Defined in: src/types/index.ts:361

Returns

string

---

useNowDateTime()

useNowDateTime(): string;

Defined in: src/types/index.ts:362

Returns

string

---

useSubtractDays()

useSubtractDays(date, days): string;

Defined in: src/types/index.ts:364

Parameters

Parameter	Type
date	string | PlainDate
days	number

Returns

string