default-number

default-number

Get a default number when a number is a non-number, a NaN or out of range.

Install

$ npm i default-number --save

Usage

• Load this module :

  const defaultNumber = require('default-number')
  

• Return the default number when the value is undefined or null.

  defaultNumber(undefined, 123) // => 123
  defaultNumber(null, 123) // => 123
  

• Return the default number when the value is NaN.

  defaultNumber(NaN, 123) // => 123
  defaultNumber(Infinity, 123) // => Infinity
  

• Return the limited number when minValue and/or maxValue is specified.

  defaultNumber(-100, 123, -50) // => -50
  defaultNumber(1000, 123, -50, 200) // => 200
  defaultNumber(1000, 123, null, 200) // => 200
  

• And return the value when it is valid and in range.

  defaultNumber(-10, 123) // => -10
  defaultNumber(-10, 123, -50, 200) // => -10
  defaultNumber(100, 123, null, 200) // => 100
  

API

defaultNumber(value, defValue [, minValue [, maxValue]]) => number

Returns the second argument when the first argument is non-number or NaN. When the third and/or fourth argument are specified, the returned value is limited in range.

• Arguments:

  • value [number] : a value to be evaluated.
  • defValue [number] : a default value which is returned if value is non-number or NaN.
  • minValue [number] : a minimum value of limitation range. (optional)
  • maxValue [number] : a maximum value of limitation range. (optional)

• Return [any] : value if it is a number and in range, defValue if value is non-number and defValue is in range, minValue if value/defValue is less minValue, or maxValue if value/defValue is greater than maxValue.

License

Copyright (C) 2017 Takayuki Sato

This program is free software under MIT License. See the file LICENSE in this distribution for more details.