Range

range-class-js

Range Class

This module is an ES6 Javascript class for creating, handling, and validating ranges with steps. You can use it in node, the browser via browserify or webpack, React or any other commanjs implementation.

npm install range-class-js

Kind: global class

• Range
  • new Range(range)
  • .min : Number
  • .max : Number
  • .step : Number
  • .stepNormalizer : Number
  • .isValid(Number) ⇒ Boolean
  • .load(range) ⇒ Boolean

new Range(range)

creates a new range instance

| Param | Type | Description | | --- | --- | --- | | range | Object | Object containing min max and step |

Example

const Range=require('range-class-js');

const range1=new Range;
range1.min=0;
range1.max=100;
range1.step=10;

const range2=new Range;
range2.load(
		{
			min:0,
			max:50,
			step:5
		}
);

const range3=new Range(
		{
			min:0,
			max:10,
			step:1
		}
);

Range.min : Number

range min, set via load method or directly

Kind: static property of Range

Range.max : Number

range max, set via load method or directly

Kind: static property of Range

Range.step : Number

range step, set via load method or directly

Kind: static property of Range
Default: 1e-2 (0.01)

Range.stepNormalizer : Number

used to normalize values and steps during valid calculations

Kind: static property of Range
Default: 1e10

Range.isValid(Number) ⇒ Boolean

checks if number is valid in range with given step

Kind: static method of Range
Returns: Boolean - Number is valid value in range with given step
Access: protected

| Param | Type | Description | | --- | --- | --- | | Number | Number | to check against range and step |

Example

const Range=require('range-class-js');

const range=new Range;
range.load(
    {
        min:0,
        max:5,
        step:1
    }
);

let valid=range.isValid(1.5);
//valid===false

valid=range.isValid(2);
//valid=== true

Range.load(range) ⇒ Boolean

converts an Object into a Range and checks validity

Kind: static method of Range
Returns: Boolean - success
Access: protected

| Param | Type | Description | | --- | --- | --- | | range | Object | the range values |

Example

const Range=require('range-class-js');

const range=new Range;
range.load(
    {
        min:0,
        max:5,
        step:0.05
    }
);