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=; const range1=;range1min=0;range1max=100;range1step=10; const range2=;range2; const range3= min:0 max:10 step:1 ;
Number
Range.min : range min, set via load method or directly
Kind: static property of Range
Number
Range.max : range max, set via load method or directly
Kind: static property of Range
Number
Range.step : range step, set via load method or directly
Kind: static property of Range
Default: 1e-2 (0.01)
Number
Range.stepNormalizer : used to normalize values and steps during valid calculations
Kind: static property of Range
Default: 1e10
Boolean
Range.isValid(Number) ⇒ 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=; const range=;range; let valid=range;//valid===false valid=range;//valid=== true
Boolean
Range.load(range) ⇒ 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=; const range=;range;