Function: contains()

contains<ElementType>(iterable: IterableResolvable<ElementType>, value: ElementType): boolean

Advances the iterable until it finds the element, returning true if it's found and false otherwise.

Type Parameters

Type Parameter
`ElementType`

Parameter	Type	Description
`iterable`	`IterableResolvable`<`ElementType`>	The iterator in which to locate a value.
`value`	`ElementType`	The value to locate in the iterator.

boolean

true if the value is found in the iterator; otherwise, false.

import { contains } from '@sapphire/iterator-utilities';

const iterable = [1, 2, 3, 4, 5];
console.log(contains(iterable, 3));
// Output: true

This function consumes the iterator until the value is found or the iterator is exhausted.