convert-units
Advanced tools
The convert-units npm package is a utility for converting between various units of measurement. It supports a wide range of units across different categories such as length, mass, volume, temperature, and more.
Length Conversion
This feature allows you to convert between different units of length. In the code sample, 1 meter is converted to feet.
const convert = require('convert-units');
const result = convert(1).from('m').to('ft');
console.log(result); // 3.28084Mass Conversion
This feature allows you to convert between different units of mass. In the code sample, 1 kilogram is converted to pounds.
const convert = require('convert-units');
const result = convert(1).from('kg').to('lb');
console.log(result); // 2.20462Volume Conversion
This feature allows you to convert between different units of volume. In the code sample, 1 liter is converted to fluid ounces.
const convert = require('convert-units');
const result = convert(1).from('l').to('fl-oz');
console.log(result); // 33.814Temperature Conversion
This feature allows you to convert between different units of temperature. In the code sample, 100 degrees Celsius is converted to Fahrenheit.
const convert = require('convert-units');
const result = convert(100).from('C').to('F');
console.log(result); // 212Speed Conversion
This feature allows you to convert between different units of speed. In the code sample, 60 kilometers per hour is converted to miles per hour.
const convert = require('convert-units');
const result = convert(60).from('km/h').to('mph');
console.log(result); // 37.2823A similar package that provides unit conversion functionalities. It supports a wide range of units and categories, making it a versatile choice for various conversion needs.
This package offers a simple API for converting between different units of measurement. It is less comprehensive than convert-units but can be a good choice for basic conversions.
A package that provides conversion functions for a variety of units. It is similar to convert-units but may have a different set of supported units and categories.
A handy utility for converting between quantities in different units.
npm install convert-units --save
convert-units has a simple chained API that is easy to read.
Here's how you move between the metric units for volume:
var convert = require('convert-units')
convert(1).from('l').to('ml')
// 1000
Jump from imperial to metric units the same way:
convert(1).from('lb').to('kg')
// 0.4536... (tested to 4 significant figures)
Just be careful not to ask for an impossible conversion:
convert(1).from('oz').to('fl-oz')
// throws -- you can't go from mass to volume!
You can ask convert-units to select the best unit for you. You can also optionally explicitly exclude orders of magnitude or specify a cut off number for selecting the best representation.
convert(12000).from('mm').toBest()
// 12 Meters (the smallest unit with a value above 1)
convert(12000).from('mm').toBest({ exclude: ['m'] })
// 1200 Centimeters (the smallest unit excluding meters)
convert(900).from('mm').toBest({ cutOffNumber: 10 });
// 900 Centimeters (the smallest unit with a value equal to or above 10)
convert(1000).from('mm').toBest({ cutOffNumber: 10 })
// 10 Meters (the smallest unit with a value equal to or above 10)
You can get a list of the measurement types supported with .measures
convert().measures()
// [ 'length', 'mass', 'volume' ]
If you ever want to know the possible conversions for a unit, just use .possibilities
convert().from('l').possibilities()
// [ 'ml', 'l', 'tsp', 'Tbs', 'fl-oz', 'cup', 'pnt', 'qt', 'gal' ]
convert().from('kg').possibilities()
// [ 'mcg', 'mg', 'g', 'kg', 'oz', 'lb' ]
You can also get the possible conversions for a measure:
convert().possibilities('mass')
// [ 'mcg', 'mg', 'g', 'kg', 'oz', 'lb', 'mt', 't' ]
You can also get the all the available units:
convert().possibilities()
// [ 'mm', 'cm', 'm', 'in', 'ft-us', 'ft', 'mi', 'mcg', 'mg', 'g', 'kg', 'oz', 'lb', 'mt', 't', 'ml', 'l', 'tsp', 'Tbs', 'fl-oz', 'cup', 'pnt', 'qt', 'gal', 'ea', 'dz' ];
To get a detailed description of a unit, use describe
convert().describe('kg')
/*
{
abbr: 'kg'
, measure: 'mass'
, system: 'metric'
, singular: 'Kilogram'
, plural: 'Kilograms'
}
*/
To get detailed descriptions of all units, use list.
convert().list()
/*
[{
abbr: 'kg'
, measure: 'mass'
, system: 'metric'
, singular: 'Kilogram'
, plural: 'Kilograms'
}, ...]
*/
You can also get detailed descriptions of all units for a measure:
convert().list('mass')
/*
[{
abbr: 'kg'
, measure: 'mass'
, system: 'metric'
, singular: 'Kilogram'
, plural: 'Kilograms'
}, ...]
*/
Adding new measurement sets is easy. Take a look at lib/definitions to see how it's done.
Copyright (c) 2013-2017 Ben Ng and Contributors, http://benng.me
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
FAQs
Convert between quantities in different units
The npm package convert-units receives a total of 140,094 weekly downloads. As such, convert-units popularity was classified as popular.
We found that convert-units demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 2 open source maintainers 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
The Socket Research team breaks down a malicious npm package targeting the legitimate DOMPurify library. It uses obfuscated code to hide that it is exfiltrating browser and crypto wallet data.
Security News
ENISA’s 2024 report highlights the EU’s top cybersecurity threats, including rising DDoS attacks, ransomware, supply chain vulnerabilities, and weaponized AI.
Security News
NIST's new password guidelines remove periodic changes and special character requirements, focusing on longer, more secure passwords for better authentication practices.