@technobuddha > library > Geometry > Rectangle

Function: isRect()

function isRect(object: unknown): object is Rect;

Defined in: is-rect.ts:20

Determines if the provided value is a Recte.

A value is considered a Rect if it is a non-null object that contains numeric x, y, 'width', and 'height' properties.

Parameters

Parameter	Type	Description
object	unknown	The value to test for Rectangle structure.

Returns

object is Rect

true if the value is a Rectangle, otherwise false.

Example

isRect({ x: 1, y: 2, width: 3, height: 4 }); // true
isRect({ x: 1, y: 2, width: 3 }); // false
isRect(null); // false
isRect([1, 2, 3, 4]); // false