@technobuddha/library/dist/date.d.ts

A large library of useful functions

/**
 * Number of ticks in a second [1000]
 * @group Time
 * @category Constants
 */
export declare const ticksPerSecond = 1000;
/**
 * Number of seconds in a minute [60]
 * @group Time
 * @category Constants
 */
export declare const secondsPerMinute = 60;
/**
 * Number of minutes in an hour [60]
 * @group Time
 * @category Constants
 */
export declare const minutesPerHour = 60;
/**
 * Number of hours in a day [24]
 * @group Time
 * @category Constants
 */
export declare const hoursPerDay = 24;
/**
 * Number of days in a week [7]
 * @group Time
 * @category Constants
 */
export declare const daysPerWeek = 7;
/**
 * Number of ticks in a minute [60000]
 * @group Time
 * @category Constants
 */
export declare const ticksPerMinute: number;
/**
 * Number of ticks in an hour [3600000]
 * @group Time
 * @category Constants
 */
export declare const ticksPerHour: number;
/**
 * Number of ticks in a day [86400000]
 * @group Time
 * @category Constants
 */
export declare const ticksPerDay: number;
/**
 * Number of ticks in a week [604800000]
 * @group Time
 * @category Constants
 */
export declare const ticksPerWeek: number;
/**
 * Number of seconds in an hour [3600]
 * @group Time
 * @category Constants
 */
export declare const secondsPerHour: number;
/**
 * Number of seconds in a day [86400]
 * @group Time
 * @category Constants
 */
export declare const secondsPerDay: number;
/**
 * Number of seconds in a week [604800]
 * @group Time
 * @category Constants
 */
export declare const secondsPerWeek: number;
/**
 * Number of minutes in a day [1440]
 * @group Time
 * @category Constants
 */
export declare const minutesPerDay: number;
/**
 * Number of minutes in a week [10080]
 * @group Time
 * @category Constants
 */
export declare const minutesPerWeek: number;
/**
 * Number of hours in a week [168]
 * @group Time
 * @category Constants
 */
export declare const hoursPerWeek: number;
/**
 * Days of the week
 * @group Time
 * @category Enumerations
 */
export type DayOfWeek = 0 | 1 | 2 | 3 | 4 | 5 | 6;
/**
 * Translation object for name of day to day number.
 * @group Time
 * @category Enumerations
 */
export declare const day: Readonly<Record<string, DayOfWeek>>;
/**
 * Months of the year
 * @group Time
 * @category Enumerations
 */
export type MonthOfYear = 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11;
/**
 * Translation object for name of month to month number
 * @group Time
 * @category Enumerations
 */
export declare const month: Readonly<Record<string, MonthOfYear>>;
/**
 * Options for date functions
 * @group Time
 * @category Date
 */
export type DateOptions = {
    /** Use the UTC timezone */
    utc?: boolean;
    /** Which day of the week is considered the beginning */
    firstDayOfWeek?: DayOfWeek;
};