Skip to main content

Function: includes()

Returns true if any value of iterable is equal to searchElement using Object.is. Otherwise returns false.

Like Array.prototype.includes, but for iterables.

Example​

console.log(
  pipe(
    [`sloth`, `more sloth`, `even more sloth`],
    includes(3),
  ),
)
//=> true

includes(searchElement)​

includes(searchElement): <Value>(iterable) => boolean

Returns true if any value of iterable is equal to searchElement using Object.is. Otherwise returns false.

Like Array.prototype.includes, but for iterables.

Parameters​

• searchElement: unknown

Returns​

Function

Type Parameters​

• Value

Parameters​

• iterable: Iterable<Value, any, any>

Returns​

boolean

Example​

console.log(
  pipe(
    [`sloth`, `more sloth`, `even more sloth`],
    includes(3),
  ),
)
//=> true

Defined in​

predicates.d.ts:241

includes(searchElement, iterable)​

includes<Value>(searchElement, iterable): boolean

Returns true if any value of iterable is equal to searchElement using Object.is. Otherwise returns false.

Like Array.prototype.includes, but for iterables.

Type Parameters​

• Value

Parameters​

• searchElement: unknown

• iterable: Iterable<Value, any, any>

Returns​

boolean

Example​

console.log(
  pipe(
    [`sloth`, `more sloth`, `even more sloth`],
    includes(3),
  ),
)
//=> true

Defined in​

predicates.d.ts:242