Menu
Documentationbreadcrumb arrow Grafana k6breadcrumb arrow JavaScript APIbreadcrumb arrow jslibbreadcrumb arrow testingbreadcrumb arrow Non-Retrying Assertionsbreadcrumb arrow toHaveLength()
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.5.0/index.js';

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

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