Interfaces

• BaseOptions
• Params

Type Aliases

• Add
• COMPASS
• DateTime
• Duration
• DURATION
• DURATIONS
• Element
• ELEMENT
• Format
• FormatRegistry
• Formats
• FormatType
• Groups
• hh
• Logic
• mi
• mm
• Modifier
• Month
• MONTH
• MONTHS
• ms
• Mutate
• ns
• Options
• OwnFormat
• Pair
• Pattern
• Relative
• SEASON
• Set
• ss
• Unit
• Until
• us
• Weekday
• WEEKDAY
• WEEKDAYS
• ww

Variables

• tickers

Functions

• duration
• ticker

Accessors

COMPASS

Get Signature

get COMPASS(): Extend<EnumifyType<{
  East: "east";
  North: "north";
  South: "south";
  West: "west";
}>, string, string>;

Compass cardinal points

Returns

Extend<EnumifyType<{ East: "east"; North: "north"; South: "south"; West: "west"; }>, string, string>

---

DURATION

Get Signature

get DURATION(): EnumifyType<{
  day: 86400;
  hour: 3600;
  microsecond: 0.000001;
  millisecond: 0.001;
  minute: 60;
  month: 2628000;
  nanosecond: 1e-9;
  second: 1;
  week: 604800;
  year: 31536000;
}>;

Time durations as seconds (singular)

Returns

EnumifyType<{ day: 86400; hour: 3600; microsecond: 0.000001; millisecond: 0.001; minute: 60; month: 2628000; nanosecond: 1e-9; second: 1; week: 604800; year: 31536000; }>

---

DURATIONS

Get Signature

get DURATIONS(): EnumifyType<{
  days: 86400000;
  hours: 3600000;
  microseconds: 0.001;
  milliseconds: 1;
  minutes: 60000;
  months: 2628000000;
  nanoseconds: 0.000001;
  seconds: 1000;
  weeks: 604800000;
  years: 31536000000;
}>;

Time durations as milliseconds (plural)

Returns

EnumifyType<{ days: 86400000; hours: 3600000; microseconds: 0.001; milliseconds: 1; minutes: 60000; months: 2628000000; nanoseconds: 0.000001; seconds: 1000; weeks: 604800000; years: 31536000000; }>

---

ELEMENT

Get Signature

get ELEMENT(): EnumifyType<{
  dd: "day";
  hh: "hour";
  mi: "minute";
  mm: "month";
  ms: "millisecond";
  ns: "nanosecond";
  ss: "second";
  us: "microsecond";
  ww: "week";
  yy: "year";
}>;

Tempo to Temporal DateTime Units map

Returns

EnumifyType<{ dd: "day"; hh: "hour"; mi: "minute"; mm: "month"; ms: "millisecond"; ns: "nanosecond"; ss: "second"; us: "microsecond"; ww: "week"; yy: "year"; }>

---

MONTH

Get Signature

get MONTH(): EnumifyType<Index<readonly ["All", "Jan", "Feb", "Mar", "Apr", "May", "Jun", "Jul", "Aug", "Sep", "Oct", "Nov", "Dec"]>>;

Month names (short-form)

Returns

EnumifyType<Index<readonly ["All", "Jan", "Feb", "Mar", "Apr", "May", "Jun", "Jul", "Aug", "Sep", "Oct", "Nov", "Dec"]>>

---

MONTHS

Get Signature

get MONTHS(): EnumifyType<Index<readonly ["Every", "January", "February", "March", "April", "May", "June", "July", "August", "September", "October", "November", "December"]>>;

Month names (long-form)

Returns

EnumifyType<Index<readonly ["Every", "January", "February", "March", "April", "May", "June", "July", "August", "September", "October", "November", "December"]>>

---

SEASON

Get Signature

get SEASON(): EnumifyType<{
  Autumn: "autumn";
  Spring: "spring";
  Summer: "summer";
  Winter: "winter";
}>;

Quarterly Seasons

Returns

EnumifyType<{ Autumn: "autumn"; Spring: "spring"; Summer: "summer"; Winter: "winter"; }>

---

WEEKDAY

Get Signature

get WEEKDAY(): EnumifyType<Index<readonly ["All", "Mon", "Tue", "Wed", "Thu", "Fri", "Sat", "Sun"]>>;

Weekday names (short-form)

Returns

EnumifyType<Index<readonly ["All", "Mon", "Tue", "Wed", "Thu", "Fri", "Sat", "Sun"]>>

---

WEEKDAYS

Get Signature

get WEEKDAYS(): EnumifyType<Index<readonly ["Everyday", "Monday", "Tuesday", "Wednesday", "Thursday", "Friday", "Saturday", "Sunday"]>>;

Weekday names (long-form)

Returns

EnumifyType<Index<readonly ["Everyday", "Monday", "Tuesday", "Wednesday", "Thursday", "Friday", "Saturday", "Sunday"]>>