@types/ms

  • Version 2.1.0
  • Published
  • 5.1 kB
  • No dependencies
  • MIT license

Install

npm i @types/ms
yarn add @types/ms
pnpm add @types/ms

Overview

TypeScript definitions for ms

Index

Functions

Type Aliases

Functions

function ms

ms: {
(value: number, options?: { long: boolean }): string;
(value: ms.StringValue): number;
};
  • Short/Long format for value.

    Parameter value

    Parameter options

    {String}

  • Parse the given value and return milliseconds.

    Parameter value

    {Number}

Type Aliases

type StringValue

type StringValue =
| `${number}`
| `${number}${UnitAnyCase}`
| `${number} ${UnitAnyCase}`;

    type Unit

    type Unit =
    | 'Years'
    | 'Year'
    | 'Yrs'
    | 'Yr'
    | 'Y'
    | 'Weeks'
    | 'Week'
    | 'W'
    | 'Days'
    | 'Day'
    | 'D'
    | 'Hours'
    | 'Hour'
    | 'Hrs'
    | 'Hr'
    | 'H'
    | 'Minutes'
    | 'Minute'
    | 'Mins'
    | 'Min'
    | 'M'
    | 'Seconds'
    | 'Second'
    | 'Secs'
    | 'Sec'
    | 's'
    | 'Milliseconds'
    | 'Millisecond'
    | 'Msecs'
    | 'Msec'
    | 'Ms';

      type UnitAnyCase

      type UnitAnyCase = Unit | Uppercase<Unit> | Lowercase<Unit>;

        Package Files (1)

        Dependencies (0)

        No dependencies.

        Dev Dependencies (0)

        No dev dependencies.

        Peer Dependencies (0)

        No peer dependencies.

        Badge

        To add a badge like this onejsDocs.io badgeto your package's README, use the codes available below.

        You may also use Shields.io to create a custom badge linking to https://www.jsdocs.io/package/@types/ms.

        • Markdown
          [![jsDocs.io](https://img.shields.io/badge/jsDocs.io-reference-blue)](https://www.jsdocs.io/package/@types/ms)
        • HTML
          <a href="https://www.jsdocs.io/package/@types/ms"><img src="https://img.shields.io/badge/jsDocs.io-reference-blue" alt="jsDocs.io"></a>