Skip to main content

@rbxts/expect > Assertion > least

Assertion.least() method​

Asserts that the value is greater than or equal to value.

Signature:

least(value: number): Assertion<number>;

Parameters​

Parameter

Type

Description

value

number

A number that the actual value should be greater than or equal to.

Returns:

Assertion<number>

Remarks​

Type alias for greaterThanOrEqualTo.

Example​

expect(5).to.be.at.least(4);
expect(2).to.be.at.least(2);