inRange

📏 Checks if a number is within the specified range (inclusive).

Syntax

TypeScript
import { inRange } from '@opentf/std';
inRange(n: number, options: { start: number; end: number }): boolean;

Parameters

NameTypeDescription
nnumberThe number to check.
options{ start: number; end: number }The inclusive start and end of the range.

Returns

True if n is between start and end.

Examples

TypeScript
inRange(3, { start: 0, end: 5 }) //=> true
inRange(-1, { start: 0, end: 5 }) //=> false

Try it

Last updated on
Edit this page