@ssv/core
Version:
Core utilities, components and services for browser and node
66 lines (65 loc) • 2.63 kB
TypeScript
export declare enum TimeUnits {
Milliseconds = 0,
Seconds = 1,
Minutes = 2,
Hours = 3,
Days = 4
}
export declare const MILLIS_PER_SECOND = 1000;
export declare const SECONDS_PER_MINUTE = 60;
export declare const MINUTES_PER_HOUR = 60;
export declare const HOURS_PER_DAY = 24;
export declare const MINUTES_PER_DAY: number;
export declare const SECONDS_PER_DAY: number;
export declare const MILLIS_PER_MINUTE: number;
export declare const MILLIS_PER_DAY: number;
/**
* Converts from milliseconds to seconds e.g. 2500 (ms) => 2.5 (s)
* @param milliseconds value to convert e.g. 2500
* @returns time in seconds
*/
export declare function fromMillisecondsToSeconds(milliseconds: number): number;
/**
* Converts from milliseconds to minutes e.g. 72000 (ms) => 1.2 (m)
* @param milliseconds value to convert e.g. 72000
* @returns time in minutes
*/
export declare function fromMillisecondsToMinutes(milliseconds: number): number;
/**
* Converts from seconds to milliseconds e.g. 2.5 (s) => 2500 (ms)
* @param seconds value to convert e.g. 2.5
* @returns time in milliseconds
*/
export declare function fromSecondsToMilliseconds(seconds: number): number;
/**
* Converts from seconds to minutes e.g. 120 (s) => 2 (m)
* @param seconds value to convert e.g. 120
* @returns time in minutes
*/
export declare function fromSecondsToMinutes(seconds: number): number;
/**
* Converts from minutes to milliseconds e.g. 2 (m) => 120000 (m)
* @param seconds value to convert e.g. 2
* @returns time in milliseconds
*/
export declare function fromMinutesToMilliseconds(minutes: number): number;
/**
* Converts from minutes to seconds e.g. 2 (m) => 120 (s)
* @param seconds value to convert e.g. 2
* @returns time in seconds
*/
export declare function fromMinutesToSeconds(minutes: number): number;
/**
* Converts time from specified time unit to an other time unit.
*
* @param value value to convert e.g. 2
* @param fromUnit units to convert time from
* @param toUnit units to convert time to
* @returns time in specified units
*/
export declare function convertTime(value: number, fromUnit: TimeUnits, toUnit: TimeUnits): number;
export declare function fromMillisecondsTo(value: number, toUnit: TimeUnits): number;
export declare function fromSecondsTo(value: number, toUnit: TimeUnits): number;
export declare function fromMinutesTo(value: number, toUnit: TimeUnits): number;
export declare function fromHoursTo(value: number, toUnit: TimeUnits): number;
export declare function fromDaysTo(value: number, toUnit: TimeUnits): number;