Skip to main content

Variable: includes()

const includes: {(searchElement): <Value>(iterable) => boolean; <Value>(searchElement, iterable): boolean; }

Defined in: predicates.d.ts:392

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

Like Array.prototype.includes, but for iterables.

Call Signature​

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

Parameters​

searchElement​

unknown

Returns​

<Value>(iterable): boolean

Type Parameters​

Value​

Value

Parameters​

iterable​

Iterable<Value>

Returns​

boolean

Call Signature​

<Value>(searchElement, iterable): boolean

Type Parameters​

Value​

Value

Parameters​

searchElement​

unknown

iterable​

Iterable<Value>

Returns​

boolean

Example​

import { includes, pipe } from 'lfi'

console.log(
  pipe(
    [`sloth`, `lazy`, `sleep`],
    includes(`lazy`),
  ),
)
//=> true

console.log(
  pipe(
    [`sloth`, `lazy`, `sleep`],
    includes(`awake`),
  ),
)
//=> false
Playground

Since​

v0.0.2