npmpackage.info

The total size of the npm registry is estimated to be over 4 terabytes. This includes all the packages, versions, and metadata stored in the registry.

ms

Tiny millisecond conversion utility

2.1.3

5,095

MIT

TypeScript

701.00 B

37,068,858,414

4.3

Installations

npm install ms

Score

99.4

Supply Chain Risk

84.7

Quality

82.6

Maintenance

100

Vulnerability

Pull Requests

Open

11

Total

129

Closed

55

Merged

63

Issues

Open

19

Total

77

Closed

58

Releases

3.0.0-canary.1

Published on 15 Sept 2021

3.0.0-canary.0

Published on 15 Sept 2021

2.1.3

Published on 08 Dec 2020

2.1.2

Published on 06 Jun 2019

2.1.1

Published on 30 Nov 2017

2.1.0

Published on 30 Nov 2017

View all 20 releases

Contributors

106

View all 106 contributors

Developer

vercel

Statistics

5,095 Stars

163 Commits

262 Forks

84 Watching

7 Branches

106 Contributors

Updated on 03 Sept 2024

Bundle Size

1.51 kB

Minified

701.00 B

Minified + Gzipped

Bundlephobia

Languages

TypeScript (91.41%)

JavaScript (8.4%)

Shell (0.19%)

Total Downloads

Cumulative downloads

Total Downloads

37,068,858,414

Last day

-3.4%

10,940,349

Compared to previous day

Last week

-0.6%

224,337,386

Compared to previous week

Last month

-6.3%

930,130,679

Compared to previous month

Last year

12.4%

11,132,697,404

Compared to previous year

Weekly Downloads

Monthly Downloads

Yearly Downloads

Dev Dependencies

eslint expect.js husky lint-staged mocha prettier

Versions

ms

Use this package to easily convert various time formats to milliseconds.

Examples

ms('2 days')  // 172800000
ms('1d')      // 86400000
ms('10h')     // 36000000
ms('2.5 hrs') // 9000000
ms('2h')      // 7200000
ms('1m')      // 60000
ms('5s')      // 5000
ms('1y')      // 31557600000
ms('100')     // 100
ms('-3 days') // -259200000
ms('-1h')     // -3600000
ms('-200')    // -200

Convert from Milliseconds

ms(60000)             // "1m"
ms(2 * 60000)         // "2m"
ms(-3 * 60000)        // "-3m"
ms(ms('10 hours'))    // "10h"

Time Format Written-Out

ms(60000, { long: true })             // "1 minute"
ms(2 * 60000, { long: true })         // "2 minutes"
ms(-3 * 60000, { long: true })        // "-3 minutes"
ms(ms('10 hours'), { long: true })    // "10 hours"

Features

Works both in Node.js and in the browser
If a number is supplied to ms, a string with a unit is returned
If a string that contains the number is supplied, it returns it as a number (e.g.: it returns 100 for '100')
If you pass a string with a number and a valid unit, the number of equivalent milliseconds is returned

TypeScript support

As of v3.0, this package includes TypeScript definitions.

For added safety, we're using Template Literal Types (added in TypeScript 4.1). This ensures that you don't accidentally pass ms values that it can't process.

This won't require you to do anything special in most situations, but you can also import the StringValue type from ms if you need to use it.

import ms, { StringValue } from 'ms';

// Using the exported type.
function example(value: StringValue) {
  ms(value);
}

// This function will only accept a string compatible with `ms`.
example('1 h');

In this example, we use a Type Assertion to coerce a string.

import ms, { StringValue } from 'ms';

// Type assertion with the exported type.
function example(value: string) {
  try {
    // A string could be "wider" than the values accepted by `ms`, so we assert
    // that our `value` is a `StringValue`.
    //
    // It's important to note that this can be dangerous (see below).
    ms(value as StringValue);
  } catch (error: Error) {
    // Handle any errors from invalid values.
    console.error(error);
  }
}

// This function will accept any string, which may result in a bug.
example('any value');

You may also create a custom Template Literal Type.

import ms from 'ms';

type OnlyDaysAndWeeks = `${number} ${'days' | 'weeks'}`;

// Using a custom Template Literal Type.
function example(value: OnlyDaysAndWeeks) {
  // The type of `value` is narrower than the values `ms` accepts, which is
  // safe to use without coercion.
  ms(value);
}

// This function will accept "# days" or "# weeks" only.
example('5.2 days');

Advanced Usage

As of v3.0, you can import parse and format separately.

import { parse, format } from 'ms';

parse('1h'); // 3600000

format(2000); // "2s"

If you want strict type checking for the input value, you can use parseStrict.

import { parseStrict } from 'ms';

parseStrict('1h'); // 3600000

function example(s: string) {
  return parseStrict(str); // tsc error
}

Edge Runtime Support

ms is compatible with the Edge Runtime. It can be used inside environments like Vercel Edge Functions as follows:

// Next.js (pages/api/edge.js) (npm i next@canary)
// Other frameworks (api/edge.js) (npm i -g vercel@canary)

import ms from 'ms';
const start = Date.now();

export default (req) => {
  return new Response(`Alive since ${ms(Date.now() - start)}`);
};

export const config = {
  runtime: 'experimental-edge',
};

Related Packages

ms.macro - Run ms as a macro at build-time.

Caught a Bug?

Fork this repository to your own GitHub account and then clone it to your local device
Link the package to the global module directory: npm link
Within the module you want to test your local development instance of ms, just link it to the dependencies: npm link ms. Instead of the default one from npm, Node.js will now use your clone of ms!

Determines if the project has declared and pinned the dependencies of its build process.

Reason

dependency not pinned by hash detected -- score normalized to 0

Details

Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/ci.yml:18: update your workflow using https://app.stepsecurity.io/secureworkflow/vercel/ms/ci.yml/main?enable=pin
Warn: third-party GitHubAction not pinned by hash: .github/workflows/ci.yml:21: update your workflow using https://app.stepsecurity.io/secureworkflow/vercel/ms/ci.yml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/ci.yml:26: update your workflow using https://app.stepsecurity.io/secureworkflow/vercel/ms/ci.yml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/quality.yml:39: update your workflow using https://app.stepsecurity.io/secureworkflow/vercel/ms/quality.yml/main?enable=pin
Warn: third-party GitHubAction not pinned by hash: .github/workflows/quality.yml:42: update your workflow using https://app.stepsecurity.io/secureworkflow/vercel/ms/quality.yml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/quality.yml:47: update your workflow using https://app.stepsecurity.io/secureworkflow/vercel/ms/quality.yml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/quality.yml:63: update your workflow using https://app.stepsecurity.io/secureworkflow/vercel/ms/quality.yml/main?enable=pin
Warn: third-party GitHubAction not pinned by hash: .github/workflows/quality.yml:66: update your workflow using https://app.stepsecurity.io/secureworkflow/vercel/ms/quality.yml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/quality.yml:71: update your workflow using https://app.stepsecurity.io/secureworkflow/vercel/ms/quality.yml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/quality.yml:15: update your workflow using https://app.stepsecurity.io/secureworkflow/vercel/ms/quality.yml/main?enable=pin
Warn: third-party GitHubAction not pinned by hash: .github/workflows/quality.yml:18: update your workflow using https://app.stepsecurity.io/secureworkflow/vercel/ms/quality.yml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/quality.yml:23: update your workflow using https://app.stepsecurity.io/secureworkflow/vercel/ms/quality.yml/main?enable=pin
Info: 0 out of 8 GitHub-owned GitHubAction dependencies pinned
Info: 0 out of 4 third-party GitHubAction dependencies pinned

0

Fuzzing

Determines if the project uses fuzzing.

0

SAST

Determines if the project uses static code analysis.

Score

4.3

/10

Last Scanned on 2024-08-26

The Open Source Security Foundation is a cross-industry collaboration to improve the security of open source software (OSS). The Scorecard provides security health metrics for open source projects.

Learn More

Other packages similar to ms

pretty-ms

9.1.0

Convert milliseconds to a human readable string: `1337000000` → `15d 11h 23m 20s`

parse-ms

4.0.0

Parse milliseconds into an object

tedious

18.6.1

A TDS driver, for connecting to MS SQLServer databases.

postcss-convert-values

7.0.4

Convert values with PostCSS (e.g. ms -> s)