@date-vir/duration
Version:
Durations units an utils for date-vir.
51 lines (50 loc) • 1.3 kB
TypeScript
/**
* The names of each day of the week, in English and capitalized.
*
* @category Unit
*/
export declare enum DayOfWeekName {
Sunday = "Sunday",
Monday = "Monday",
Tuesday = "Tuesday",
Wednesday = "Wednesday",
Thursday = "Thursday",
Friday = "Friday",
Saturday = "Saturday"
}
/**
* All valid day of the week indexes as a type. 0 = Sunday and 6 = Saturday.
*
* @category Unit
*/
export type DayOfWeekIndex = 0 | 1 | 2 | 3 | 4 | 5 | 6;
/**
* Bounds for valid day of the week indexes.
*
* @category Internal
*/
export declare const dayOfWeekIndexBounds: {
readonly min: 0;
readonly max: 6;
};
/**
* Maps {@link DayOfWeekName} to {@link DayOfWeekIndex}.
*
* @category Util
*/
export declare const dayOfWeekNameToIndex: {
readonly Sunday: 0;
readonly Monday: 1;
readonly Tuesday: 2;
readonly Wednesday: 3;
readonly Thursday: 4;
readonly Friday: 5;
readonly Saturday: 6;
};
/**
* An array of {@link DayOfWeekName} in index order. This can be accessed by any
* {@link DayOfWeekIndex} number.
*
* @category Util
*/
export declare const dayOfWeekNameOrder: [DayOfWeekName.Sunday, DayOfWeekName.Monday, DayOfWeekName.Tuesday, DayOfWeekName.Wednesday, DayOfWeekName.Thursday, DayOfWeekName.Friday, DayOfWeekName.Saturday];