JSPM

  • ESM via JSPM
  • ES Module Entrypoint
  • Export Map
  • Keywords
  • License
  • Repository URL
  • TypeScript Types
  • README
  • Created
  • Published
  • Downloads 8
  • Score
    100M100P100Q26977F
  • License MIT

Remove all non-number characters and return a number. '$1,234' → 1234

Package Exports

  • just-numbers

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (just-numbers) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

just-numbers

Build Status

Remove all non-number characters and return a number. '$1,234' → 1234

This module will also attempt to preserve your decimal precision using the float option: '$1,234.12' → 1234.12

Install

$ npm install --save just-numbers

Usage

const justNumbers = require('just-numbers');

justNumbers('$1,234.00');
//=> 123400

justNumbers('$1$2$3$4$5');
//=> 12345

justNumbers('no-numbers-in-string');
//=> 0

justNumbers('$1,234.23', {float: true});
//=> 1234.23

v1.0

The 0.x version of this module would simply return 0 (zero) when no numbers were found in the string. This behavior has changed in v1.0, and now undefined is returned when no numbers are found in the string. If you want to mimic the behavior of 0.x, you can tell just-numbers to return zero on empty with the zeroOnEmpty option.

Version 1.0 also allows you to supply your own return value in the event of an empty string using the onNull option.

API

just-numbers(input, [options])

Returns a number, undefined or a custom value.

input

Type: string

The string containing numbers.

options

float

Type: boolean
Default: false

Turns on the attempt to preserve your decimal precision in strings.

justNumbers('$123,456,789.02', {float: true});
//=> 123456789.02
zeroOnEmpty

Type: boolean
Default: false

Returns 0 on empty strings (mimics the 0.x API)

justNumbers('no numbers here', {zeroOnEmpty: true});
//=> 0
onNull

Type: string|object
Default: undefined

Override the return value when no numbers are found in the string.

justNumbers('no numbers here', {onNull: Infinity});
//=> Infinity

justNumbers('no numbers here', {onNull: 'NO NUMBERS!'});
//=> "NO NUMBERS!"

Tip: To avoid quirky behavior when overriding the onNull value, avoid values like {onNull: undefined}, {onNull: null}, or {onNull: 0}. Instead, just use the default behaviors (which returns undefined) or the zeroOnEmpty option.

License

MIT © Michael Wuergler