Skip to main content

Function: includesConcur()

Returns a promise that resolves to true if any value of concurIterable is equal to searchElement using Object.is. Otherwise returns a promise that resolves to false.

Like Array.prototype.includes, but for concur iterables.

Example​

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

includesConcur(searchElement)​

includesConcur(searchElement): <Value>(concurIterable) => Promise<boolean>

Returns a promise that resolves to true if any value of concurIterable is equal to searchElement using Object.is. Otherwise returns a promise that resolves to false.

Like Array.prototype.includes, but for concur iterables.

Parameters​

• searchElement: unknown

Returns​

Function

Type Parameters​

• Value

Parameters​

• concurIterable: ConcurIterable<Value>

Returns​

Promise<boolean>

Example​

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

Defined in​

predicates.d.ts:296

includesConcur(searchElement, concurIterable)​

includesConcur<Value>(searchElement, concurIterable): Promise<boolean>

Returns a promise that resolves to true if any value of concurIterable is equal to searchElement using Object.is. Otherwise returns a promise that resolves to false.

Like Array.prototype.includes, but for concur iterables.

Type Parameters​

• Value

Parameters​

• searchElement: unknown

• concurIterable: ConcurIterable<Value>

Returns​

Promise<boolean>

Example​

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

Defined in​

predicates.d.ts:299