Skip to main content

Variable: filter()

const filter: {<From, To>(fn): (iterable) => Iterable<To>; <From, To>(fn, iterable): Iterable<To>; <Value>(fn): (iterable) => Iterable<Value>; <Value>(fn, iterable): Iterable<Value>; }

Defined in: filters.d.ts:28

Returns an iterable that contains the values of iterable in iteration order excluding the values for which fn returns a falsy value.

Like Array.prototype.filter, but for iterables.

Call Signature​

<From, To>(fn): (iterable) => Iterable<To>

Type Parameters​

From​

From

To​

To

Parameters​

fn​

(value) => value is To

Returns​

(iterable): Iterable<To>

Parameters​

iterable​

Iterable<From>

Returns​

Iterable<To>

Call Signature​

<From, To>(fn, iterable): Iterable<To>

Type Parameters​

From​

From

To​

To

Parameters​

fn​

(value) => value is To

iterable​

Iterable<From>

Returns​

Iterable<To>

Call Signature​

<Value>(fn): (iterable) => Iterable<Value>

Type Parameters​

Value​

Value

Parameters​

fn​

(value) => unknown

Returns​

(iterable): Iterable<Value>

Parameters​

iterable​

Iterable<Value>

Returns​

Iterable<Value>

Call Signature​

<Value>(fn, iterable): Iterable<Value>

Type Parameters​

Value​

Value

Parameters​

fn​

(value) => unknown

iterable​

Iterable<Value>

Returns​

Iterable<Value>

Example​

import { filter, pipe, reduce, toArray } from 'lfi'

console.log(
  pipe(
    [`sloth`, `lazy`, `sleep`],
    filter(word => word.startsWith(`s`)),
    reduce(toArray()),
  ),
)
//=> [ 'sloth', 'sleep' ]
Playground

Since​

v0.0.1