Introduction

The clamp package provides functionality to force a given numerical value to be within a given range.

Installation

This package should be installed via npm. You must have npm installed first. The following can be run on the commandline to install the clamp package with npm:

npm install @nicolawealth/clamp

Interface

The package exports the function clamp(value, low, high, def) where low and high define the acceptable range for value to be in. If value is undefined then it is reassigned to the value of def before clamping. If value is below the given range, it is reassigned to the value of low to clamp it. If value is above the given range, it is reassigned to the value of high to clamp it.

Testing

Tests can be found in clamp.test.ts located in clamp/src and should be run with sinon, mocha and nyc.