@rbxts/expect > Assertion > array

Assertion.array() method

Asserts that the value is an array.

Signature:

array(): Assertion<T extends unknown[] ? T : T[]>;

Returns:

Assertion<T extends unknown[] ? T : T[]>

Remarks

An array is classified as a table of incrementing number keys that start at 1, and without any holes.

Example

expect([1,2,3]).to.be.an.array();
expect({ name: "daymon" }).to.not.be.an.array();