You're Invited:Meet the Socket Team at BlackHat and DEF CON in Las Vegas, Aug 7-8.RSVP
Socket
Socket
Sign inDemoInstall

default-number

Package Overview
Dependencies
1
Maintainers
1
Versions
1
Alerts
File Explorer

Advanced tools

Install Socket

Detect and block malicious and high-risk dependencies

Install

default-number

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


Version published
Weekly downloads
630
increased by68%
Maintainers
1
Created
Weekly downloads
 

Readme

Source

default-number NPM MIT License Build Status Build Status Coverage Status

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.

Keywords

FAQs

Package last updated on 02 Apr 2017

Did you know?

Socket

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.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap
  • Changelog

Packages

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc