hap-fluent / createRangePredicate

Function: createRangePredicate()

function createRangePredicate(
   min, 
   max, 
inclusive?): ValuePredicate<number>;

Defined in: packages/hap-fluent/src/type-utils.ts:268

Create a ValuePredicate that validates whether a number falls within [min, max].

Parameters

Parameter	Type	Default value	Description
min	number	undefined	Minimum value.
max	number	undefined	Maximum value.
inclusive	boolean	true	When true (default), the bounds are inclusive.

Returns

ValuePredicate<number>

A predicate returning true if the value is within range.

Example

const isValidHue = createRangePredicate(0, 360);
isValidHue(180); // Returns true
isValidHue(400); // Returns false
isValidHue(0);   // Returns true (inclusive)