https://github.com/thomwright/parseunit

Parse a string with a number and unit e.g. '12px' -> [12, 'px']
https://github.com/thomwright/parseunit

Last synced: 8 months ago
JSON representation

Parse a string with a number and unit e.g. '12px' -> [12, 'px']

• Host: GitHub
• URL: https://github.com/thomwright/parseunit
• Owner: ThomWright
• License: mit
• Created: 2015-08-04T18:13:27.000Z (over 10 years ago)
• Default Branch: master
• Last Pushed: 2015-11-01T01:24:33.000Z (about 10 years ago)
• Last Synced: 2025-05-07T21:05:29.746Z (8 months ago)
• Language: JavaScript
• Homepage:
• Size: 148 KB
• Stars: 2
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# parseunit

[![Travis](https://img.shields.io/travis/ThomWright/parseunit.svg?style=flat-square)](https://travis-ci.org/ThomWright/parseunit)

[![npm](https://img.shields.io/npm/v/parseunit.svg?style=flat-square)](https://www.npmjs.com/package/parseunit)

[![David](https://img.shields.io/david/ThomWright/parseunit.svg?style=flat-square)](https://david-dm.org/ThomWright/parseunit)

[![David](https://img.shields.io/david/dev/ThomWright/parseunit.svg?style=flat-square)](https://david-dm.org/ThomWright/parseunit#info=devDependencies)

Parse strings with a number and unit.

## API

### ES5

```javascript

var parse = require('parseunit');

var parsed = parse('12px');

console.log(parsed[0], parsed[1]); // 12 'px'

// or parse into an object for better readability

var parseObj = parse.parseObj;

var parsed = parseObj('12px');

console.log(parsed.val, parsed.unit); // 12 'px'

```

### ES6

```javascript

import parseUnit, {parseUnitObj} from 'parseunit';

const [val, unit] = parseUnit('12px');

// or

const {val, unit} = parseUnitObj('12px');

console.log(val, unit); // 12 'px'

```

### `parseUnit`

*Default export*

**Params**

- **str** `string`

**Returns**

- **[val, unit]** `[number, string]`

### `parseUnitObj`

**Params**

- **str** `string`

**Returns**

- **{val, unit}** `{number, string}`

## Alternatives

[parse-unit](https://www.npmjs.com/package/parse-unit)