npmpackage.info

Gathering detailed insights and metrics for ms

Other packages similar to ms

@types/ms

0.7.34

TypeScript definitions for ms

humanize-ms

1.2.1

transform humanize time to ms

postcss-convert-values

7.0.4

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

tedious

18.6.1

A TDS driver, for connecting to MS SQLServer databases.

Gathering detailed insights and metrics for ms

ms

Tiny millisecond conversion utility

2.1.3

5,165

MIT

TypeScript

701.00 B

39,959,632,487 4.2

Installations

npm install ms

Score

99.4

Supply Chain

84.7

Quality

82.6

Maintenance

100

Vulnerability

100

License

Pull Requests

Open

10

Total

129

Closed

56

Merged

63

Issues

Open

18

Total

77

Closed

59

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

105

View all 105 contributors

Developer

vercel

Developer Guide

BETA

Module System

CommonJS

Min. Node Version

Typescript Support

No

Node Version

12.18.3

NPM Version

6.14.6 Statistics

5,165 Stars

163 Commits

265 Forks

83 Watching

7 Branches

105 Contributors

Updated on 27 Nov 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

39,959,632,487

Last day

-23.7%

39,398,369

Compared to previous day

Last week

-4.6%

275,189,598

Compared to previous week

Last month

11.2%

1,149,876,163

Compared to previous month

Last year

12.5%

11,571,089,969

Compared to previous year

Daily Downloads

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

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

Convert from Milliseconds

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

Time Format Written-Out

1ms(60000, { long: true })             // "1 minute"
2ms(2 * 60000, { long: true })         // "2 minutes"
3ms(-3 * 60000, { long: true })        // "-3 minutes"
4ms(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.

1import ms, { StringValue } from 'ms';
2
3// Using the exported type.
4function example(value: StringValue) {
5  ms(value);
6}
7
8// This function will only accept a string compatible with `ms`.
9example('1 h');

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

1import ms, { StringValue } from 'ms';
2
3// Type assertion with the exported type.
4function example(value: string) {
5  try {
6    // A string could be "wider" than the values accepted by `ms`, so we assert
7    // that our `value` is a `StringValue`.
8    //
9    // It's important to note that this can be dangerous (see below).
10    ms(value as StringValue);
11  } catch (error: Error) {
12    // Handle any errors from invalid values.
13    console.error(error);
14  }
15}
16
17// This function will accept any string, which may result in a bug.
18example('any value');

You may also create a custom Template Literal Type.

1import ms from 'ms';
2
3type OnlyDaysAndWeeks = `${number} ${'days' | 'weeks'}`;
4
5// Using a custom Template Literal Type.
6function example(value: OnlyDaysAndWeeks) {
7  // The type of `value` is narrower than the values `ms` accepts, which is
8  // safe to use without coercion.
9  ms(value);
10}
11
12// This function will accept "# days" or "# weeks" only.
13example('5.2 days');

Advanced Usage

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

1import { parse, format } from 'ms';
2
3parse('1h'); // 3600000
4
5format(2000); // "2s"

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

1import { parseStrict } from 'ms';
2
3parseStrict('1h'); // 3600000
4
5function example(s: string) {
6  return parseStrict(str); // tsc error
7}

Edge Runtime Support

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

1// Next.js (pages/api/edge.js) (npm i next@canary)
2// Other frameworks (api/edge.js) (npm i -g vercel@canary)
3
4import ms from 'ms';
5const start = Date.now();
6
7export default (req) => {
8  return new Response(`Alive since ${ms(Date.now() - start)}`);
9};
10
11export const config = {
12  runtime: 'experimental-edge',
13};

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!

As always, you can run the tests using: npm test

Stable Version

The latest stable version of the package.

Stable Version

2.1.3

HIGH

7.5/10

Summary

Regular Expression Denial of Service in ms

Affected Versions

< 0.7.1

Patched Versions

0.7.1

MODERATE

5.3/10

Summary

Vercel ms Inefficient Regular Expression Complexity vulnerability

Affected Versions

< 2.0.0

Patched Versions

2.0.0

10

Dangerous-Workflow

Determines if the project's GitHub Action workflows avoid dangerous patterns.

10

Binary-Artifacts

Determines if the project has generated executable (binary) artifacts in the source repository.

10

License

Determines if the project has defined a license.

10

Security-Policy

Determines if the project has published a security policy.

6

Code-Review

Determines if the project requires human code review before pull requests (aka merge requests) are merged.

1

Vulnerabilities

Determines if the project has open, known unfixed vulnerabilities.

0

Maintained

Determines if the project is "actively maintained".

0

Token-Permissions

Determines if the project's workflows follow the principle of least privilege.

0

Pinned-Dependencies

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: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
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
Info: 0 out of 8 GitHub-owned GitHubAction dependencies pinned
Info: 0 out of 4 third-party GitHubAction dependencies pinned

0

CII-Best-Practices

Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.

0

Fuzzing

Determines if the project uses fuzzing.

0

SAST

Determines if the project uses static code analysis.

Score

4.2

/10

Last Scanned on 2024-11-18

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