@types/ms
Advanced tools
Package description
The @types/ms package provides TypeScript type definitions for the ms package, which is a utility to easily convert various time formats to milliseconds and vice versa. It's particularly useful when working with time-related operations in Node.js applications. By using @types/ms, developers can get autocomplete and type checking functionalities for the ms package in TypeScript projects, enhancing development efficiency and reducing runtime errors.
Convert time format to milliseconds
This feature allows you to convert human-readable time formats (like '2 days', '1h', or '10 hours') into milliseconds. It's particularly useful for setting timeouts, intervals, or calculating time differences in applications.
"import ms from 'ms';\nconsole.log(ms('2 days')); // 172800000\nconsole.log(ms('1h')); // 3600000\nconsole.log(ms('10 hours')); // 36000000"Convert milliseconds to time format
This feature enables the conversion of milliseconds into a more human-readable time format. It supports both short and long formats, and can also handle negative values, which can be useful for displaying countdowns or elapsed time.
"import ms from 'ms';\nconsole.log(ms(60000, { long: true })); // '1 minute'\nconsole.log(ms(2 * 60000)); // '2m'\nconsole.log(ms(-3 * 60000, { long: true })); // '-3 minutes'"Moment.js is a comprehensive date handling library that can parse, validate, manipulate, and display dates and times in JavaScript. While it offers much broader functionality compared to ms, including timezone support, it's also significantly larger in size. For projects that only require simple conversion between time formats and milliseconds, ms (and by extension @types/ms for TypeScript users) might be more lightweight and straightforward.
Day.js is a minimalist JavaScript library that parses, validates, manipulates, and displays dates and times for modern browsers with a largely Moment.js-compatible API. Like Moment.js, it offers a wide range of functionalities beyond what ms provides, including plugin support for additional features like timezone handling. However, it's designed to be more lightweight and faster, making it a closer alternative to ms in terms of performance and simplicity, especially for projects that might require a bit more flexibility than ms offers.
Date-fns is a modern JavaScript date utility library featuring a comprehensive set of functions for manipulating, parsing, and formatting dates. It's modular, allowing developers to pick and choose which functions they need, potentially resulting in smaller bundle sizes. Compared to ms, date-fns offers a much broader scope of date-related functionalities but maintains a focus on performance and simplicity. For TypeScript users, it includes its own type definitions, eliminating the need for separate @types packages.
Readme
npm install --save @types/ms
This package contains type definitions for ms (https://github.com/zeit/ms).
Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/ms.
/**
* Short/Long format for `value`.
*
* @param {Number} value
* @param {{long: boolean}} options
* @return {String}
*/
declare function ms(value: number, options?: { long: boolean }): string;
/**
* Parse the given `value` and return milliseconds.
*
* @param {String} value
* @return {Number}
*/
declare function ms(value: string): number;
export = ms;
These definitions were written by Zhiyuan Wang.
FAQs
TypeScript definitions for ms
The npm package @types/ms receives a total of 6,844,847 weekly downloads. As such, @types/ms popularity was classified as popular.
We found that @types/ms demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
As cyber threats become more autonomous, AI-powered defenses are crucial for businesses to stay ahead of attackers who can exploit software vulnerabilities at scale.
Security News
UnitedHealth Group disclosed that the ransomware attack on Change Healthcare compromised protected health information for millions in the U.S., with estimated costs to the company expected to reach $1 billion.
Security News
GitHub is susceptible to a CDN flaw that allows attackers to host malware on any public repository.