Important: This documentation is about an older version. It's relevant only to the release noted, many of the features and functions have been updated or replaced. Please view the current version.

Open source

toHaveLength()

The toHaveLength() method asserts that an object has a specific length property value. This is commonly used with arrays, strings, and other objects that have a length property.

Syntax

JavaScript
expect(actual).toHaveLength(expected);
expect(actual).not.toHaveLength(expected);

Parameters

ParameterTypeDescription
expectednumberThe expected length value

Returns

TypeDescription
voidNo return value

Description

The toHaveLength() method checks if an object has a length property that equals the expected value. It works with arrays, strings, and any object that has a numeric length property.

Usage

JavaScript
import { expect } from 'https://jslib.k6.io/k6-testing/0.6.1/index.js';

export default function () {
  const fruit = 'mango';

  expect(fruit).toHaveLength(5);
  expect(fruit).not.toHaveLength(2);
}