lodash.clamp

What is lodash.clamp?

The lodash.clamp package is a utility function that clamps a number within the inclusive lower and upper bounds. It is part of the Lodash library, which provides utility functions for common programming tasks.

What are lodash.clamp's main functionalities?

Clamping a number within a range

This feature allows you to clamp a number within a specified range. In this example, the number 10 is clamped to the upper bound of 5.

const clamp = require('lodash.clamp');

const result = clamp(10, 0, 5);
console.log(result); // Output: 5

Clamping a number to the lower bound

This feature allows you to clamp a number to the lower bound if it is below the specified range. In this example, the number -5 is clamped to the lower bound of 0.

const clamp = require('lodash.clamp');

const result = clamp(-5, 0, 5);
console.log(result); // Output: 0

Clamping a number within a range where it is already within bounds

This feature allows you to clamp a number that is already within the specified range. In this example, the number 3 remains unchanged as it is within the range of 0 to 5.

const clamp = require('lodash.clamp');

const result = clamp(3, 0, 5);
console.log(result); // Output: 3

Other packages similar to lodash.clamp

clamp-js

The clamp-js package provides similar functionality to lodash.clamp by clamping a number within a specified range. It is a lightweight alternative with a similar API.

clamp-number

The clamp-number package is another alternative that clamps a number within a given range. It offers a straightforward API and is focused solely on the clamping functionality.

README

lodash.clamp v4.0.3

The lodash method _.clamp exported as a Node.js module.

Installation

Using npm:

$ {sudo -H} npm i -g npm
$ npm i --save lodash.clamp

In Node.js:

var clamp = require('lodash.clamp');

See the documentation or package source for more details.