Filter29

Constructors

bigintconstA predefined filter that only passes through bigint primitive values.booleanconstA predefined filter that only passes through boolean values.dateconstA predefined filter that only passes through Date objects.equalsconstCreates a filter that only passes values equal to the specified value using structural equality.equalsStrictconstCreates a Filter that passes only values strictly equal to the specified value using JavaScript === comparison.fromPredicateconstCreates a Filter from a predicate or refinement function.fromPredicateOptionconstCreates a Filter from a function that returns an Option; Some(value) passes with value, and None fails with the original input.hasconstCreates a Filter that passes inputs whose has(key) method returns true for the specified key.instanceOfconstCreates a filter that only passes instances of the given constructor.makeconstCreates a Filter from a function that returns either a pass or fail value.makeEffectconstCreates an effectful Filter from a function that returns an Effect.numberconstA predefined filter that only passes through number values.reasonconstCreates a filter that extracts a reason from a tagged error.stringconstA predefined filter that only passes through string values.symbolconstA predefined filter that only passes through Symbol values.taggedconstCreates a filter that checks if an input is tagged with a specific tag.

Models

FilterinterfaceRepresents a filter function that can transform inputs to outputs or filter them out.FilterEffectinterfaceRepresents an effectful filter function that can produce Effects.

Combinators

andLeftconstCombines two filters but only returns the result of the left filter.andRightconstCombines two filters but only returns the result of the right filter.composeconstComposes two filters sequentially, feeding the output of the first into the second.composePassthroughconstComposes two filters sequentially, passing the successful output of the first filter to the second.orconstCombines two filters with logical OR semantics.zipconstCombines two filters into a tuple of their results.zipWithconstCombines two filters and applies a function to their results.

Mapping

mapFailconstTransforms the failure value produced by a Filter, leaving successful results unchanged.

Converting

toOptionconstConverts a Filter into a function that returns Some for passed values and None for filtered-out values.toPredicateconstConverts a Filter into a predicate function.toResultconstConverts a Filter into a function that returns the underlying Result.Result for each input.