Method startsWith

source/predicates/array.ts:59–64

Test an array to start with a specific value. The value is tested by identity, not structure. @param searchElement - The value that should be the start of the array.

(searchElement: T)

	@param searchElement - The value that should be the start of the array.
	*/
	startsWith(searchElement: T): this {
		return this.addValidator({
			message: (value, label) => `Expected ${label} to start with \`${searchElement}\`, got \`${value[0]}\``,
			validator: value => value[0] === searchElement,
		});
	}

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