Method maxLength

source/predicates/array.ts:46–52

Test an array to have a maximum length. @param length - The maximum length of the array.

(length: number)

	@param length - The maximum length of the array.
	*/
	maxLength(length: number): this {
		return this.addValidator({
			message: (value, label) => `Expected ${label} to have a maximum length of \`${length}\`, got \`${value.length}\``,
			validator: value => value.length <= length,
			negatedMessage: (value, label) => `Expected ${label} to have a minimum length of \`${length + 1}\`, got \`${value.length}\``,
		});
	}

	/**
	Test an array to start with a specific value. The value is tested by identity, not structure.