https://github.com/toddself/split-measure-units

Split up the amount and units designator and optionally convert to a new unit
https://github.com/toddself/split-measure-units

Last synced: 9 months ago
JSON representation

Split up the amount and units designator and optionally convert to a new unit

• Host: GitHub
• URL: https://github.com/toddself/split-measure-units
• Owner: toddself
• License: other
• Created: 2015-11-02T03:35:36.000Z (over 10 years ago)
• Default Branch: master
• Last Pushed: 2015-11-09T18:07:40.000Z (over 10 years ago)
• Last Synced: 2025-03-15T05:12:06.314Z (over 1 year ago)
• Language: JavaScript
• Size: 129 KB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
[![Build Status](https://travis-ci.org/toddself/split-measure-units.svg?branch=master)](https://travis-ci.org/toddself/split-measure-units)

# split-measure-units

A small function that will separate out the amount from the units in a normal English measurement phrase, and optionally convert it to a different unit

## ES6 Module!

This is authored as an ES6 module and relies on ES6 features. The `main` key in `package.json` points to the transpiled ES5 source, but the `jsnext:main` key points to the ES6 original source. If your environement supports: 

* block scoping (`let` & `const`)

* destructuring (`let [abbott, costello] = ['abbot', 'costello']`)

* ES6 `import` and `export`

Then feel free to use the ES6 source directly.

## Usage

```js

import splitMeasure from 'split-measure-units'

console.log(splitMeasure('1 cup')) // [1, 'cup', 'cup']

console.log(splitMeasure('12 minutes')) // [12, 'minutes', 'minutes']

console.log(splitMeasure('62.45 hampsters')) // [62.45, 'hampsters', 'hampsters']

console.log(splitMeasure('1 gal', 'qt')) // [4, 'qt', 'gal']

```

The method takes two arguments: the measurement and an optional unit to convert to.  For conversions is relies on [convert-units](https://github.com/ben-ng/convert-units/), so see that documentation for what units it can convert. It will also support converting between Farhenheit and Celsius independant of the convert-units library