typedash/dist/clamp-zT1oLiyc.cjs

modern, type-safe collection of utility functions

//#region src/functions/clamp/clamp.ts
/**
* Clamps a number to a specified range.
* @param value The number to clamp.
* @param range The range to clamp to, as a tuple of min and max values.
* @param options Optional parameters.
* @param options.inclusive Whether the clamping should be inclusive of the min and/or max value.
* - If `true`, the clamping is inclusive of both min and max.
* - If `false`, the clamping is exclusive of both min and max.
* - If `'min'`, the clamping is inclusive of the min value but exclusive of the max value.
* - If `'max'`, the clamping is exclusive of the min value but inclusive of the max value.
* @returns The clamped number.
* @example
* ```typescript
* clamp(3, [1, 5]); // 3
* clamp(5, [1, 5]); // 5
* clamp(5, [1, 5], { inclusive: false }); // 4
* clamp(1, [1, 5], { inclusive: 'max' }); // 5
* ```
*/
function clamp(value, range, options) {
	const [min, max] = range;
	if (min > max) throw new RangeError(`Invalid range: [${min},${max}]`);
	const { inclusive = true } = options ?? {};
	return {
		true: () => Math.max(min, Math.min(max, value)),
		false: () => Math.max(min + 1, Math.min(max - 1, value)),
		min: () => Math.max(min, Math.min(max - 1, value)),
		max: () => Math.max(min + 1, Math.min(max, value))
	}[inclusive]();
}

//#endregion
Object.defineProperty(exports, 'clamp', {
  enumerable: true,
  get: function () {
    return clamp;
  }
});
//# sourceMappingURL=clamp-zT1oLiyc.cjs.map