array.includes()

This method operates on an array. You typically fetch documents from a collection as a set, not an Array. For the equivalent Set method, see set instance methods.

For differences between Sets and Arrays, see Sets vs. Arrays.

Test if the Array includes a provided element.

Signature

includes(element: A) => Boolean

Description

Tests if the Array includes a provided element.

Parameters

Parameter Type Required Description

element

Generic

true

Element to check the Array for.

Return value

Type Description

Boolean

If true, the Array contains the provided element. Otherwise, false.

Examples

let iter = [1, 2, 3]
iter.includes(2)
true
\