Constants

Try in Playground →

Time conversion constants and shared utility types

Examples on this page are verified against the `ts-time-utils` v4.4.1 public exports.

Import

import { ... } from 'ts-time-utils/constants';

Examples

Time Conversion Constants

Use built-in constants instead of repeating conversion math

import {
  MILLISECONDS_PER_MINUTE,
  MILLISECONDS_PER_HOUR,
  MILLISECONDS_PER_DAY,
  SECONDS_PER_HOUR,
} from 'ts-time-utils/constants';

const timeoutMinutes = 15;
const timeoutMs = timeoutMinutes * MILLISECONDS_PER_MINUTE;
console.log(timeoutMs);
// 900000

const eventDurationHours = 36;
console.log(eventDurationHours * MILLISECONDS_PER_HOUR);
// 129600000

console.log(MILLISECONDS_PER_DAY);
// 86400000

console.log(SECONDS_PER_HOUR);
// 3600

Typed Time Units

Reuse the shared time-unit types in your own helpers

import type { TimeUnit, FormatOptions } from 'ts-time-utils/constants';

function normalizeUnit(unit: TimeUnit): TimeUnit {
  if (unit === 'hours') return 'hour';
  if (unit === 'minutes') return 'minute';
  return unit;
}

const options: FormatOptions = {
  short: true,
  maxUnits: 2,
};

console.log(normalizeUnit('hours'));
// "hour"

console.log(options);
// { short: true, maxUnits: 2 }