normalize-duration v1.0.0

normalize-duration

Normalize a duration in different time units then chose your favourite format.

normalizeDuration({ milliseconds: 3500 });
// return { milliseconds: 500, seconds: 3 }

normalizeDuration({ seconds: 5541 });
// return { seconds: 21, minutes: 32, hours: 1 }

Table of contents

• Installation
  • Node
  • Deno
• Usage
  • Optional Parameters

Installation

Node

# If you use npm
npm install normalize-duration

# If you use yarn
yarn add normalize-duration

Deno

If you use Deno, you can just import the package from deno.land/x

import { normalizeDuration } from "https://deno.land/x/normalize_duration/mod.ts";

Usage

The first parameter is a Duration object in the following format:

export type Duration = {
  years?: number;
  months?: number;
  days?: number;
  hours?: number;
  minutes?: number;
  seconds?: number;
  milliseconds?: number;
};

You can fill as many fields as you want and pass it to normalizeDuration which will return a Duration object with the normalized values.

normalizeDuration({ years: 1, months: 20, days: 3 });
// return { years: 2, months: 8, days: 3 }

Optional Parameters

You can get extra customization with some optional parameters:

export type Options = {
  customUnits?: (keyof Duration)[];
  stripZeroes?: boolean;
};

• customUnits: Only the units defined here will be used.
• stripZeroes: If true, will strip zeroes from the output.