Reference
TypeScript
Public Tarikh types and compile-time contracts for the core API and React entry point.
Start Here
Use this page when you want to know which types to import before wiring the API.
Public Types
import type {
BanglaCalendarDate,
BanglaCalendarDateLocalized,
BanglaCalendarFormatOptions,
BanglaCalendarOptions,
BanglaCalendarDayFormat,
BanglaCalendarDaySpokenVariant,
BanglaDayFormatOptions,
DateFormatOptions,
DateInput,
DateParseOptions,
FormatMode,
FormatOptions,
HijriCalendarDate,
HijriCalendarDateLocalized,
HijriCalendarFormatOptions,
HijriCalendarOptions,
HijriTimeZone,
HybridDateFormatOptions,
Language,
Locale,
MonthFormat,
RelativeTimeOptions,
TimeFormat,
WeekdayFormat,
YearFormat
} from "@coreify/tarikh";
import type { TarikhProps } from "@coreify/tarikh/react";import type {
BanglaDateProps,
HijriDateProps,
RelativeTimeProps
} from "@coreify/tarikh/react";Key Contracts
| Type | Purpose |
|---|---|
FormatOptions | Main formatting contract for format() |
FormatMode | The supported standard, bangla, hijri, and hybrid modes |
DateInput | Accepted input shape for core APIs |
RelativeTimeOptions | Options for fromNow() |
DateParseOptions | Parser controls, including calendar: "bangla" |
HijriTimeZone | The supported Hijri timezone union |
React Types
| Type | Purpose |
|---|---|
TarikhProps | Props for the main React <Tarikh /> component |
BanglaDateProps | Props for Tarikh.Bangla |
HijriDateProps | Props for Tarikh.Hijri |
RelativeTimeProps | Props for Tarikh.Relative |
Compile-Time Rules
| Rule | Behavior |
|---|---|
pattern formatting | Disallows mode in TypeScript |
mode: "standard" | Uses DateFormatOptions |
mode: "bangla" | Uses Bangla calendar options |
mode: "hijri" | Uses Hijri calendar options |
mode: "hybrid" | Uses hybrid date formatting options |
These types are designed so invalid
format()combinations fail at compile time before they reach runtime.