effect 4.0.0-beta.67 → 4.0.0-beta.68

package/dist/Filter.d.ts

@@ -58,7 +58,7 @@ import type { EqualsWith, ExcludeTag, ExtractReason, ExtractTag, ReasonTags, Tag
  * console.log(positiveFilter(-3)) // Result.fail(-3)
  * ```
  *
- * @category Models
+ * @category models
  * @since 4.0.0
  */
 export interface Filter<in Input, out Pass = Input, out Fail = Input> {
@@ -92,7 +92,7 @@ export interface Filter<in Input, out Pass = Input, out Fail = Input> {
  *   })
  * ```
  *
- * @category Models
+ * @category models
  * @since 4.0.0
  */
 export interface FilterEffect<in Input, out Pass, out Fail, out E = never, out R = never> {
@@ -118,7 +118,7 @@ export interface FilterEffect<in Input, out Pass, out Fail, out E = never, out R
  * )
  * ```
  *
- * @category Constructors
+ * @category constructors
  * @since 4.0.0
  */
 export declare const make: <Input, Pass, Fail>(f: (input: Input) => Result.Result<Pass, Fail>) => Filter<Input, Pass, Fail>;
@@ -143,7 +143,7 @@ export declare const make: <Input, Pass, Fail>(f: (input: Input) => Result.Resul
  * )
  * ```
  *
- * @category Constructors
+ * @category constructors
  * @since 4.0.0
  */
 export declare const makeEffect: <Input, Pass, Fail, E, R>(f: (input: Input) => Effect<Result.Result<Pass, Fail>, E, R>) => FilterEffect<Input, Pass, Fail, E, R>;
@@ -151,7 +151,7 @@ export declare const makeEffect: <Input, Pass, Fail, E, R>(f: (input: Input) =>
  * Transforms the failure value produced by a `Filter`, leaving successful
  * results unchanged.
  *
- * @category Mapping
+ * @category mapping
  * @since 4.0.0
  */
 export declare const mapFail: {
@@ -159,7 +159,7 @@ export declare const mapFail: {
      * Transforms the failure value produced by a `Filter`, leaving successful
      * results unchanged.
      *
-     * @category Mapping
+     * @category mapping
      * @since 4.0.0
      */
     <Fail, Fail2>(f: (fail: Fail) => Fail2): <Input, Pass>(self: Filter<Input, Pass, Fail>) => Filter<Input, Pass, Fail2>;
@@ -167,7 +167,7 @@ export declare const mapFail: {
      * Transforms the failure value produced by a `Filter`, leaving successful
      * results unchanged.
      *
-     * @category Mapping
+     * @category mapping
      * @since 4.0.0
      */
     <Input, Pass, Fail, Fail2>(self: Filter<Input, Pass, Fail>, f: (fail: Fail) => Fail2): Filter<Input, Pass, Fail2>;
@@ -178,7 +178,7 @@ export {
  * Creates a Filter that tries to apply a function and returns `fail` on
  * error.
  *
- * @category Constructors
+ * @category constructors
  * @since 4.0.0
  */
 try_ as try };
@@ -204,7 +204,7 @@ try_ as try };
  * )
  * ```
  *
- * @category Constructors
+ * @category constructors
  * @since 4.0.0
  */
 export declare const fromPredicate: {
@@ -230,7 +230,7 @@ export declare const fromPredicate: {
      * )
      * ```
      *
-     * @category Constructors
+     * @category constructors
      * @since 4.0.0
      */
     <A, B extends A>(refinement: Predicate.Refinement<A, B>): Filter<A, B, EqualsWith<A, B, A, Exclude<A, B>>>;
@@ -256,7 +256,7 @@ export declare const fromPredicate: {
      * )
      * ```
      *
-     * @category Constructors
+     * @category constructors
      * @since 4.0.0
      */
     <A>(predicate: Predicate.Predicate<A>): Filter<A>;
@@ -266,14 +266,14 @@ export declare const fromPredicate: {
  *
  * `Some(value)` passes with `value`. `None` fails with the original input.
  *
- * @category Constructors
+ * @category constructors
  * @since 4.0.0
  */
 export declare const fromPredicateOption: <A, B>(predicate: (a: A) => Option.Option<B>) => Filter<A, B>;
 /**
  * Converts a Filter into a predicate function.
  *
- * @category Constructors
+ * @category constructors
  * @since 4.0.0
  */
 export declare const toPredicate: <A, Pass, Fail>(self: Filter<A, Pass, Fail>) => Predicate.Predicate<A>;
@@ -289,7 +289,7 @@ export declare const toPredicate: <A, Pass, Fail>(self: Filter<A, Pass, Fail>) =
  * console.log(Filter.string(42)) // fail
  * ```
  *
- * @category Constructors
+ * @category constructors
  * @since 4.0.0
  */
 export declare const string: Filter<unknown, string>;
@@ -297,7 +297,7 @@ export declare const string: Filter<unknown, string>;
  * Creates a `Filter` that passes only values strictly equal to the specified
  * value using JavaScript `===` comparison.
  *
- * @category Constructors
+ * @category constructors
  * @since 4.0.0
  */
 export declare const equalsStrict: <const A, Input = unknown>(value: A) => Filter<Input, A, EqualsWith<Input, A, A, Exclude<Input, A>>>;
@@ -305,7 +305,7 @@ export declare const equalsStrict: <const A, Input = unknown>(value: A) => Filte
  * Creates a `Filter` that passes inputs whose `has(key)` method returns
  * `true` for the specified key.
  *
- * @category Constructors
+ * @category constructors
  * @since 4.0.0
  */
 export declare const has: <K>(key: K) => <Input extends {
@@ -314,7 +314,7 @@ export declare const has: <K>(key: K) => <Input extends {
 /**
  * Creates a filter that only passes instances of the given constructor.
  *
- * @category Constructors
+ * @category constructors
  * @since 4.0.0
  */
 export declare const instanceOf: <K extends new (...args: any) => any>(constructor: K) => <Input>(u: Input) => Result.Result<InstanceType<K>, Exclude<Input, InstanceType<K>>>;
@@ -330,63 +330,63 @@ export declare const instanceOf: <K extends new (...args: any) => any>(construct
  * console.log(Filter.number("42")) // fail
  * ```
  *
- * @category Constructors
+ * @category constructors
  * @since 4.0.0
  */
 export declare const number: Filter<unknown, number>;
 /**
  * A predefined filter that only passes through boolean values.
  *
- * @category Constructors
+ * @category constructors
  * @since 4.0.0
  */
 export declare const boolean: Filter<unknown, boolean>;
 /**
  * A predefined filter that only passes through BigInt values.
  *
- * @category Constructors
+ * @category constructors
  * @since 4.0.0
  */
 export declare const bigint: Filter<unknown, bigint>;
 /**
  * A predefined filter that only passes through Symbol values.
  *
- * @category Constructors
+ * @category constructors
  * @since 4.0.0
  */
 export declare const symbol: Filter<unknown, symbol>;
 /**
  * A predefined filter that only passes through Date objects.
  *
- * @category Constructors
+ * @category constructors
  * @since 4.0.0
  */
 export declare const date: Filter<unknown, Date>;
 /**
  * Creates a filter that checks if an input is tagged with a specific tag.
  *
- * @category Constructors
+ * @category constructors
  * @since 4.0.0
  */
 export declare const tagged: {
     /**
      * Creates a filter that checks if an input is tagged with a specific tag.
      *
-     * @category Constructors
+     * @category constructors
      * @since 4.0.0
      */
     <Input>(): <const Tag extends Tags<Input>>(tag: Tag) => Filter<Input, ExtractTag<Input, Tag>, ExcludeTag<Input, Tag>>;
     /**
      * Creates a filter that checks if an input is tagged with a specific tag.
      *
-     * @category Constructors
+     * @category constructors
      * @since 4.0.0
      */
     <Input, const Tag extends Tags<Input>>(tag: Tag): Filter<Input, ExtractTag<Input, Tag>, ExcludeTag<Input, Tag>>;
     /**
      * Creates a filter that checks if an input is tagged with a specific tag.
      *
-     * @category Constructors
+     * @category constructors
      * @since 4.0.0
      */
     <const Tag extends string>(tag: Tag): <Input>(input: Input) => Result.Result<ExtractTag<Input, Tag>, ExcludeTag<Input, Tag>>;
@@ -394,28 +394,28 @@ export declare const tagged: {
 /**
  * Creates a filter that extracts a reason from a tagged error.
  *
- * @category Constructors
+ * @category constructors
  * @since 4.0.0
  */
 export declare const reason: {
     /**
      * Creates a filter that extracts a reason from a tagged error.
      *
-     * @category Constructors
+     * @category constructors
      * @since 4.0.0
      */
     <Input>(): <const Tag extends Tags<Input>, const ReasonTag extends ReasonTags<ExtractTag<Input, Tag>>>(tag: Tag, reasonTag: ReasonTag) => Filter<Input, ExtractReason<ExtractTag<Input, Tag>, ReasonTag>, Input>;
     /**
      * Creates a filter that extracts a reason from a tagged error.
      *
-     * @category Constructors
+     * @category constructors
      * @since 4.0.0
      */
     <Input, const Tag extends Tags<Input>, const ReasonTag extends ReasonTags<ExtractTag<Input, Tag>>>(tag: Tag, reasonTag: ReasonTag): Filter<Input, ExtractReason<ExtractTag<Input, Tag>, ReasonTag>, Input>;
     /**
      * Creates a filter that extracts a reason from a tagged error.
      *
-     * @category Constructors
+     * @category constructors
      * @since 4.0.0
      */
     <const Tag extends string, const ReasonTag extends string>(tag: Tag, reasonTag: ReasonTag): <Input>(input: Input) => Result.Result<ExtractReason<ExtractTag<Input, Tag>, ReasonTag>, Input>;
@@ -423,28 +423,28 @@ export declare const reason: {
 /**
  * Creates a filter that only passes values equal to the specified value using structural equality.
  *
- * @category Constructors
+ * @category constructors
  * @since 4.0.0
  */
 export declare const equals: <const A, Input = unknown>(value: A) => Filter<Input, A, EqualsWith<Input, A, A, Exclude<Input, A>>>;
 /**
  * Combines two filters with logical OR semantics.
  *
- * @category Combinators
+ * @category combinators
  * @since 4.0.0
  */
 export declare const or: {
     /**
      * Combines two filters with logical OR semantics.
      *
-     * @category Combinators
+     * @category combinators
      * @since 4.0.0
      */
     <Input2, Pass2, Fail2>(that: Filter<Input2, Pass2, Fail2>): <Input1, Pass2, Fail2>(self: Filter<Input1, Pass2>) => Filter<Input1 & Input2, Pass2 | Pass2, Fail2>;
     /**
      * Combines two filters with logical OR semantics.
      *
-     * @category Combinators
+     * @category combinators
      * @since 4.0.0
      */
     <Input1, Pass1, Fail1, Input2, Pass2, Fail2>(self: Filter<Input1, Pass1, Fail1>, that: Filter<Input2, Pass2, Fail2>): Filter<Input1 & Input2, Pass1 | Pass2, Fail2>;
@@ -455,7 +455,7 @@ export declare const or: {
  * Both filters must succeed (not return `fail`) for the combination to succeed.
  * If both filters pass, their outputs are combined using the provided function.
  *
- * @category Combinators
+ * @category combinators
  * @since 4.0.0
  */
 export declare const zipWith: {
@@ -465,7 +465,7 @@ export declare const zipWith: {
      * Both filters must succeed (not return `fail`) for the combination to succeed.
      * If both filters pass, their outputs are combined using the provided function.
      *
-     * @category Combinators
+     * @category combinators
      * @since 4.0.0
      */
     <PassL, InputR, PassR, FailR, A>(right: Filter<InputR, PassR, FailR>, f: (left: PassL, right: PassR) => A): <InputL, FailL>(left: Filter<InputL, PassL, FailL>) => Filter<InputL & InputR, A, FailL | FailR>;
@@ -475,7 +475,7 @@ export declare const zipWith: {
      * Both filters must succeed (not return `fail`) for the combination to succeed.
      * If both filters pass, their outputs are combined using the provided function.
      *
-     * @category Combinators
+     * @category combinators
      * @since 4.0.0
      */
     <InputL, PassL, FailL, InputR, PassR, FailR, A>(left: Filter<InputL, PassL, FailL>, right: Filter<InputR, PassR, FailR>, f: (left: PassL, right: PassR) => A): Filter<InputL & InputR, A, FailL | FailR>;
@@ -497,7 +497,7 @@ export declare const zipWith: {
  * const positiveAndEven = Filter.zip(positiveNumbers, evenNumbers)
  * ```
  *
- * @category Combinators
+ * @category combinators
  * @since 4.0.0
  */
 export declare const zip: {
@@ -518,7 +518,7 @@ export declare const zip: {
      * const positiveAndEven = Filter.zip(positiveNumbers, evenNumbers)
      * ```
      *
-     * @category Combinators
+     * @category combinators
      * @since 4.0.0
      */
     <InputR, PassR, FailR>(right: Filter<InputR, PassR, FailR>): <InputL, PassL, FailL>(left: Filter<InputL, PassL, FailL>) => Filter<InputL & InputR, [PassL, PassR], FailL | FailR>;
@@ -539,7 +539,7 @@ export declare const zip: {
      * const positiveAndEven = Filter.zip(positiveNumbers, evenNumbers)
      * ```
      *
-     * @category Combinators
+     * @category combinators
      * @since 4.0.0
      */
     <InputL, PassL, FailL, InputR, PassR, FailR>(left: Filter<InputL, PassL, FailL>, right: Filter<InputR, PassR, FailR>): Filter<InputL & InputR, [PassL, PassR], FailL | FailR>;
@@ -558,7 +558,7 @@ export declare const zip: {
  * const positiveEven = Filter.andLeft(positiveNumbers, evenNumbers)
  * ```
  *
- * @category Combinators
+ * @category combinators
  * @since 4.0.0
  */
 export declare const andLeft: {
@@ -576,7 +576,7 @@ export declare const andLeft: {
      * const positiveEven = Filter.andLeft(positiveNumbers, evenNumbers)
      * ```
      *
-     * @category Combinators
+     * @category combinators
      * @since 4.0.0
      */
     <InputR, PassR, FailR>(right: Filter<InputR, PassR, FailR>): <InputL, PassL, FailL>(left: Filter<InputL, PassL, FailL>) => Filter<InputL & InputR, PassL, FailL | FailR>;
@@ -594,7 +594,7 @@ export declare const andLeft: {
      * const positiveEven = Filter.andLeft(positiveNumbers, evenNumbers)
      * ```
      *
-     * @category Combinators
+     * @category combinators
      * @since 4.0.0
      */
     <InputL, PassL, FailL, InputR, PassR, FailR>(left: Filter<InputL, PassL, FailL>, right: Filter<InputR, PassR, FailR>): Filter<InputL & InputR, PassL, FailL | FailR>;
@@ -615,7 +615,7 @@ export declare const andLeft: {
  * const positiveDoubled = Filter.andRight(positiveNumbers, doubleNumbers)
  * ```
  *
- * @category Combinators
+ * @category combinators
  * @since 4.0.0
  */
 export declare const andRight: {
@@ -635,7 +635,7 @@ export declare const andRight: {
      * const positiveDoubled = Filter.andRight(positiveNumbers, doubleNumbers)
      * ```
      *
-     * @category Combinators
+     * @category combinators
      * @since 4.0.0
      */
     <InputR, PassR, FailR>(right: Filter<InputR, PassR, FailR>): <InputL, PassL, FailL>(left: Filter<InputL, PassL, FailL>) => Filter<InputL & InputR, PassR, FailL | FailR>;
@@ -655,7 +655,7 @@ export declare const andRight: {
      * const positiveDoubled = Filter.andRight(positiveNumbers, doubleNumbers)
      * ```
      *
-     * @category Combinators
+     * @category combinators
      * @since 4.0.0
      */
     <InputL, PassL, FailL, InputR, PassR, FailR>(left: Filter<InputL, PassL, FailL>, right: Filter<InputR, PassR, FailR>): Filter<InputL & InputR, PassR, FailL | FailR>;
@@ -676,7 +676,7 @@ export declare const andRight: {
  * const stringToUpper = Filter.compose(stringFilter, nonEmptyUpper)
  * ```
  *
- * @category Combinators
+ * @category combinators
  * @since 4.0.0
  */
 export declare const compose: {
@@ -696,7 +696,7 @@ export declare const compose: {
      * const stringToUpper = Filter.compose(stringFilter, nonEmptyUpper)
      * ```
      *
-     * @category Combinators
+     * @category combinators
      * @since 4.0.0
      */
     <PassL, PassR, FailR>(right: Filter<PassL, PassR, FailR>): <InputL, FailL>(left: Filter<InputL, PassL, FailL>) => Filter<InputL, PassR, FailL | FailR>;
@@ -716,7 +716,7 @@ export declare const compose: {
      * const stringToUpper = Filter.compose(stringFilter, nonEmptyUpper)
      * ```
      *
-     * @category Combinators
+     * @category combinators
      * @since 4.0.0
      */
     <InputL, PassL, FailL, PassR, FailR>(left: Filter<InputL, PassL, FailL>, right: Filter<PassL, PassR, FailR>): Filter<InputL, PassR, FailL | FailR>;
@@ -728,7 +728,7 @@ export declare const compose: {
  * If either filter fails, the returned filter fails with the original input
  * instead of the intermediate failure value.
  *
- * @category Combinators
+ * @category combinators
  * @since 4.0.0
  */
 export declare const composePassthrough: {
@@ -739,7 +739,7 @@ export declare const composePassthrough: {
      * If either filter fails, the returned filter fails with the original input
      * instead of the intermediate failure value.
      *
-     * @category Combinators
+     * @category combinators
      * @since 4.0.0
      */
     <InputL, PassL, PassR, FailR>(right: Filter<PassL, PassR, FailR>): <FailL>(left: Filter<InputL, PassL, FailL>) => Filter<InputL, PassR, InputL>;
@@ -750,7 +750,7 @@ export declare const composePassthrough: {
      * If either filter fails, the returned filter fails with the original input
      * instead of the intermediate failure value.
      *
-     * @category Combinators
+     * @category combinators
      * @since 4.0.0
      */
     <InputL, PassL, FailL, PassR, FailR>(left: Filter<InputL, PassL, FailL>, right: Filter<PassL, PassR, FailR>): Filter<InputL, PassR, InputL>;
@@ -759,7 +759,7 @@ export declare const composePassthrough: {
  * Converts a `Filter` into a function that returns `Some` for passed values
  * and `None` for filtered-out values.
  *
- * @category Conversions
+ * @category converting
  * @since 4.0.0
  */
 export declare const toOption: <A, Pass, Fail>(self: Filter<A, Pass, Fail>) => (input: A) => Option.Option<Pass>;
@@ -767,7 +767,7 @@ export declare const toOption: <A, Pass, Fail>(self: Filter<A, Pass, Fail>) => (
  * Converts a `Filter` into a function that returns the underlying
  * `Result.Result` for each input.
  *
- * @category Conversions
+ * @category converting
  * @since 4.0.0
  */
 export declare const toResult: <A, Pass, Fail>(self: Filter<A, Pass, Fail>) => (input: A) => Result.Result<Pass, Fail>;