Skip to content
// EFFECT DAYS 2026

Filterable

Filterable represents data structures which can be partitioned/filtered.

7 exports Since v0.24.0 Source

Models

Filterable

interface
Since v0.24.0

Signature

interface Filterable<F extends TypeLambda> extends TypeClass<F> {
readonly filterMap: {
<A, B>(f: (a: A) => Option<B>): <R, O, E>(self: Kind<F, R, O, E, A>) => Kind<F, R, O, E, B>;
<R, O, E, A, B>(self: Kind<F, R, O, E, A>, f: (a: A) => Option<B>): Kind<F, R, O, E, B>;
};
readonly partitionMap: {
<A, B, C>(f: (a: A) => Either<C, B>): <R, O, E>(self: Kind<F, R, O, E, A>) => [Kind<F, R, O, E, B>, Kind<F, R, O, E, C>];
<R, O, E, A, B, C>(self: Kind<F, R, O, E, A>, f: (a: A) => Either<C, B>): [Kind<F, R, O, E, B>, Kind<F, R, O, E, C>];
};
}

Other

Since v0.24.0

Signature

declare function compact<F extends TypeLambda>(F: Filterable<F>): <R, O, E, A>(self: Kind<F, R, O, E, Option<A>>) => Kind<F, R, O, E, A>
Since v0.24.0

Signature

declare const filter: <F extends TypeLambda>(F: Filterable<F>) => {
<C, B, A = C>(refinement: (a: A) => a is B): <R, O, E>(self: Kind<F, R, O, E, C>) => Kind<F, R, O, E, B>;
<B, A = B>(predicate: (a: A) => boolean): <R, O, E>(self: Kind<F, R, O, E, B>) => Kind<F, R, O, E, B>;
<R, O, E, C, B, A = C>(self: Kind<F, R, O, E, C>, refinement: (a: A) => a is B): Kind<F, R, O, E, B>;
<R, O, E, B, A = B>(self: Kind<F, R, O, E, B>, predicate: (a: A) => boolean): Kind<F, R, O, E, B>;
}

Returns a default binary filterMap composition.

Signature

declare function filterMapComposition<F extends TypeLambda, G extends TypeLambda>(F: Covariant<F>, G: Filterable<G>): <FR, FO, FE, GR, GO, GE, A, B>(self: Kind<F, FR, FO, FE, Kind<G, GR, GO, GE, A>>, f: (a: A) => Option<B>) => Kind<F, FR, FO, FE, Kind<G, GR, GO, GE, B>>
Since v0.24.0

Signature

declare function partition<F extends TypeLambda>(F: Filterable<F>): {
<C, B, A = C>(refinement: (a: A) => a is B): <R, O, E>(self: Kind<F, R, O, E, C>) => [Kind<F, R, O, E, C>, Kind<F, R, O, E, B>];
<B, A = B>(predicate: (a: A) => boolean): <R, O, E>(self: Kind<F, R, O, E, B>) => [Kind<F, R, O, E, B>, Kind<F, R, O, E, B>];
<R, O, E, C, B, A = C>(self: Kind<F, R, O, E, C>, refinement: (a: A) => a is B): [Kind<F, R, O, E, C>, Kind<F, R, O, E, B>];
<R, O, E, B, A = B>(self: Kind<F, R, O, E, B>, predicate: (a: A) => boolean): [Kind<F, R, O, E, B>, Kind<F, R, O, E, B>];
}

Returns a default binary partitionMap composition.

Signature

declare function partitionMapComposition<F extends TypeLambda, G extends TypeLambda>(F: Covariant<F>, G: Filterable<G>): <FR, FO, FE, GR, GO, GE, A, B, C>(self: Kind<F, FR, FO, FE, Kind<G, GR, GO, GE, A>>, f: (a: A) => Either<C, B>) => [Kind<F, FR, FO, FE, Kind<G, GR, GO, GE, B>>, Kind<F, FR, FO, FE, Kind<G, GR, GO, GE, C>>]
Since v0.24.0

Signature

declare function separate<F extends TypeLambda>(F: Filterable<F>): <R, O, E, A, B>(self: Kind<F, R, O, E, Either<B, A>>) => [Kind<F, R, O, E, A>, Kind<F, R, O, E, B>]