effect 4.0.0-beta.73 → 4.0.0-beta.74

package/dist/Match.d.ts

@@ -250,7 +250,7 @@ export interface Not {
  *
  * @see {@link value} for creating a matcher from a specific value.
  *
- * @category Creating a matcher
+ * @category constructors
  * @since 4.0.0
  */
 export declare const type: <I>() => Matcher<I, Types.Without<never>, I, never, never>;
@@ -295,7 +295,7 @@ export declare const type: <I>() => Matcher<I, Types.Without<never>, I, never, n
  *
  * @see {@link type} for creating a matcher from a specific type.
  *
- * @category Creating a matcher
+ * @category constructors
  * @since 4.0.0
  */
 export declare const value: <const I>(i: I) => Matcher<I, Types.Without<never>, I, never, I>;
@@ -325,7 +325,7 @@ export declare const value: <const I>(i: I) => Matcher<I, Types.Without<never>,
  * console.log(message) // "Success: Hello"
  * ```
  *
- * @category Creating a matcher
+ * @category constructors
  * @since 4.0.0
  */
 export declare const valueTags: {
@@ -355,7 +355,7 @@ export declare const valueTags: {
      * console.log(message) // "Success: Hello"
      * ```
      *
-     * @category Creating a matcher
+     * @category constructors
      * @since 4.0.0
      */
     <const I, P extends {
@@ -391,7 +391,7 @@ export declare const valueTags: {
      * console.log(message) // "Success: Hello"
      * ```
      *
-     * @category Creating a matcher
+     * @category constructors
      * @since 4.0.0
      */
     <const I, P extends {
@@ -445,7 +445,7 @@ export declare const valueTags: {
  * // Output: { type: "pending" }
  * ```
  *
- * @category Creating a matcher
+ * @category constructors
  * @since 4.0.0
  */
 export declare const typeTags: {
@@ -492,7 +492,7 @@ export declare const typeTags: {
      * // Output: { type: "pending" }
      * ```
      *
-     * @category Creating a matcher
+     * @category constructors
      * @since 4.0.0
      */
     <I, Ret>(): <P extends {
@@ -545,7 +545,7 @@ export declare const typeTags: {
      * // Output: { type: "pending" }
      * ```
      *
-     * @category Creating a matcher
+     * @category constructors
      * @since 4.0.0
      */
     <I>(): <P extends {
@@ -585,7 +585,7 @@ export declare const typeTags: {
  * )
  * ```
  *
- * @category utils
+ * @category utility types
  * @since 4.0.0
  */
 export declare const withReturnType: <Ret>() => <I, F, R, A, Pr, _>(self: Matcher<I, F, R, A, Pr, _>) => [Ret] extends [[A] extends [never] ? any : A] ? Matcher<I, F, R, A, Pr, Ret> : "withReturnType constraint does not extend Result type";
@@ -1129,7 +1129,7 @@ export declare const not: <R, const P extends Types.PatternPrimitive<R> | Types.
  *
  * @see {@link string} for matching any string
  *
- * @category Predicates
+ * @category predicates
  * @since 4.0.0
  */
 export declare const nonEmptyString: SafeRefinement<string, never>;
@@ -1174,7 +1174,7 @@ export declare const nonEmptyString: SafeRefinement<string, never>;
  * // Output: "Unknown status: pending"
  * ```
  *
- * @category Predicates
+ * @category predicates
  * @since 4.0.0
  */
 export declare const is: <Literals extends ReadonlyArray<string | number | bigint | boolean | null>>(...literals: Literals) => SafeRefinement<Literals[number]>;
@@ -1295,7 +1295,7 @@ export declare const number: Predicate.Refinement<unknown, number>;
  * @see {@link defined} for matching only non-nullish values
  * @see {@link orElse} for providing a fallback after earlier cases
  *
- * @category Predicates
+ * @category predicates
  * @since 4.0.0
  */
 export declare const any: SafeRefinement<unknown, any>;
@@ -1343,7 +1343,7 @@ export declare const any: SafeRefinement<unknown, any>;
  *
  * @see {@link any} for matching every value without excluding nullish inputs
  *
- * @category Predicates
+ * @category predicates
  * @since 4.0.0
  */
 export declare const defined: <A>(u: A) => u is A & {};
@@ -1404,7 +1404,7 @@ export {
  * @see {@link defined} for matching non-nullish values
  * @see {@link is} for matching literal values
  *
- * @category Predicates
+ * @category predicates
  * @since 4.0.0
  */
 _undefined as undefined };
@@ -1425,7 +1425,7 @@ export {
  * @see {@link defined} for matching non-nullish values
  * @see {@link is} for matching literal values
  *
- * @category Predicates
+ * @category predicates
  * @since 4.0.0
  */
 _null as null };
@@ -1647,7 +1647,7 @@ export declare const record: Predicate.Refinement<unknown, {
  * @see {@link instanceOfUnsafe} for constructor matching without the same type-safety guarantee
  * @see {@link record} for matching broad non-null, non-array objects
  *
- * @category Predicates
+ * @category predicates
  * @since 4.0.0
  */
 export declare const instanceOf: <A extends abstract new (...args: any) => any>(constructor: A) => SafeRefinement<InstanceType<A>, never>;
@@ -1730,7 +1730,7 @@ export declare const instanceOfUnsafe: <A extends abstract new (...args: any) =>
  * @see {@link result} for returning unmatched input as a `Result` failure
  * @see {@link orElseAbsurd} for finalizing when unmatched input should be impossible
  *
- * @category Completion
+ * @category completion
  * @since 4.0.0
  */
 export declare const orElse: <RA, Ret, F extends (_: RA) => Ret>(f: F) => <I, R, A, Pr>(self: Matcher<I, R, RA, A, Pr, Ret>) => [Pr] extends [never] ? (input: I) => Unify<ReturnType<F> | A> : Unify<ReturnType<F> | A>;
@@ -1814,7 +1814,7 @@ export declare const orElseAbsurd: <I, R, RA, A, Pr, Ret>(self: Matcher<I, R, RA
  * // Output: { _id: 'Result', _tag: 'Err', err: { role: 'viewer' } }
  * ```
  *
- * @category Completion
+ * @category completion
  * @since 4.0.0
  */
 export declare const result: <I, F, R, A, Pr, Ret>(self: Matcher<I, F, R, A, Pr, Ret>) => [Pr] extends [never] ? (input: I) => Result.Result<Unify<A>, R> : Result.Result<Unify<A>, R>;
@@ -1860,7 +1860,7 @@ export declare const result: <I, F, R, A, Pr, Ret>(self: Matcher<I, F, R, A, Pr,
  * @see {@link result} for preserving unmatched input as a `Result` failure
  * @see {@link orElse} for replacing unmatched input with a fallback value
  *
- * @category Completion
+ * @category completion
  * @since 4.0.0
  */
 export declare const option: <I, F, R, A, Pr, Ret>(self: Matcher<I, F, R, A, Pr, Ret>) => [Pr] extends [never] ? (input: I) => Option.Option<Unify<A>> : Option.Option<Unify<A>>;
@@ -1893,7 +1893,7 @@ export declare const option: <I, F, R, A, Pr, Ret>(self: Matcher<I, F, R, A, Pr,
  * )
  * ```
  *
- * @category Completion
+ * @category completion
  * @since 4.0.0
  */
 export declare const exhaustive: <I, F, A, Pr, Ret>(self: Matcher<I, F, never, A, Pr, Ret>) => [Pr] extends [never] ? (u: I) => Unify<A> : Unify<A>;

package/dist/Match.js

@@ -88,7 +88,7 @@ const TypeId = internal.TypeId;
  *
  * @see {@link value} for creating a matcher from a specific value.
  *
- * @category Creating a matcher
+ * @category constructors
  * @since 4.0.0
  */
 export const type = internal.type;
@@ -133,7 +133,7 @@ export const type = internal.type;
  *
  * @see {@link type} for creating a matcher from a specific type.
  *
- * @category Creating a matcher
+ * @category constructors
  * @since 4.0.0
  */
 export const value = internal.value;
@@ -163,7 +163,7 @@ export const value = internal.value;
  * console.log(message) // "Success: Hello"
  * ```
  *
- * @category Creating a matcher
+ * @category constructors
  * @since 4.0.0
  */
 export const valueTags = internal.valueTags;
@@ -210,7 +210,7 @@ export const valueTags = internal.valueTags;
  * // Output: { type: "pending" }
  * ```
  *
- * @category Creating a matcher
+ * @category constructors
  * @since 4.0.0
  */
 export const typeTags = internal.typeTags;
@@ -243,7 +243,7 @@ export const typeTags = internal.typeTags;
  * )
  * ```
  *
- * @category utils
+ * @category utility types
  * @since 4.0.0
  */
 export const withReturnType = internal.withReturnType;
@@ -771,7 +771,7 @@ export const not = internal.not;
  *
  * @see {@link string} for matching any string
  *
- * @category Predicates
+ * @category predicates
  * @since 4.0.0
  */
 export const nonEmptyString = internal.nonEmptyString;
@@ -816,7 +816,7 @@ export const nonEmptyString = internal.nonEmptyString;
  * // Output: "Unknown status: pending"
  * ```
  *
- * @category Predicates
+ * @category predicates
  * @since 4.0.0
  */
 export const is = internal.is;
@@ -937,7 +937,7 @@ export const number = Predicate.isNumber;
  * @see {@link defined} for matching only non-nullish values
  * @see {@link orElse} for providing a fallback after earlier cases
  *
- * @category Predicates
+ * @category predicates
  * @since 4.0.0
  */
 export const any = internal.any;
@@ -985,7 +985,7 @@ export const any = internal.any;
  *
  * @see {@link any} for matching every value without excluding nullish inputs
  *
- * @category Predicates
+ * @category predicates
  * @since 4.0.0
  */
 export const defined = internal.defined;
@@ -1046,7 +1046,7 @@ export {
  * @see {@link defined} for matching non-nullish values
  * @see {@link is} for matching literal values
  *
- * @category Predicates
+ * @category predicates
  * @since 4.0.0
  */
 _undefined as undefined };
@@ -1067,7 +1067,7 @@ export {
  * @see {@link defined} for matching non-nullish values
  * @see {@link is} for matching literal values
  *
- * @category Predicates
+ * @category predicates
  * @since 4.0.0
  */
 _null as null };
@@ -1287,7 +1287,7 @@ export const record = Predicate.isObject;
  * @see {@link instanceOfUnsafe} for constructor matching without the same type-safety guarantee
  * @see {@link record} for matching broad non-null, non-array objects
  *
- * @category Predicates
+ * @category predicates
  * @since 4.0.0
  */
 export const instanceOf = internal.instanceOf;
@@ -1370,7 +1370,7 @@ export const instanceOfUnsafe = internal.instanceOf;
  * @see {@link result} for returning unmatched input as a `Result` failure
  * @see {@link orElseAbsurd} for finalizing when unmatched input should be impossible
  *
- * @category Completion
+ * @category completion
  * @since 4.0.0
  */
 export const orElse = internal.orElse;
@@ -1455,7 +1455,7 @@ export const orElseAbsurd = internal.orElseAbsurd;
  * // Output: { _id: 'Result', _tag: 'Err', err: { role: 'viewer' } }
  * ```
  *
- * @category Completion
+ * @category completion
  * @since 4.0.0
  */
 export const result = internal.result;
@@ -1501,7 +1501,7 @@ export const result = internal.result;
  * @see {@link result} for preserving unmatched input as a `Result` failure
  * @see {@link orElse} for replacing unmatched input with a fallback value
  *
- * @category Completion
+ * @category completion
  * @since 4.0.0
  */
 export const option = internal.option;
@@ -1534,7 +1534,7 @@ export const option = internal.option;
  * )
  * ```
  *
- * @category Completion
+ * @category completion
  * @since 4.0.0
  */
 export const exhaustive = internal.exhaustive;

package/dist/Metric.d.ts

@@ -242,7 +242,7 @@ export interface Metric<in Input, out State> extends Pipeable {
  * })
  * ```
  *
- * @category Metrics
+ * @category metrics
  * @since 2.0.0
  */
 export interface Counter<in Input extends number | bigint> extends Metric<Input, CounterState<Input>> {
@@ -391,7 +391,7 @@ export interface CounterState<in Input extends number | bigint> {
  * })
  * ```
  *
- * @category Metrics
+ * @category metrics
  * @since 2.0.0
  */
 export interface Frequency extends Metric<string, FrequencyState> {
@@ -476,7 +476,7 @@ export interface Frequency extends Metric<string, FrequencyState> {
  * })
  * ```
  *
- * @category Metrics
+ * @category metrics
  * @since 4.0.0
  */
 export interface FrequencyState {
@@ -538,7 +538,7 @@ export interface FrequencyState {
  * })
  * ```
  *
- * @category Metrics
+ * @category metrics
  * @since 2.0.0
  */
 export interface Gauge<in Input extends number | bigint> extends Metric<Input, GaugeState<Input>> {
@@ -607,7 +607,7 @@ export interface Gauge<in Input extends number | bigint> extends Metric<Input, G
  * })
  * ```
  *
- * @category Metrics
+ * @category metrics
  * @since 4.0.0
  */
 export interface GaugeState<in Input extends number | bigint> {
@@ -697,7 +697,7 @@ export interface GaugeState<in Input extends number | bigint> {
  * })
  * ```
  *
- * @category Metrics
+ * @category metrics
  * @since 2.0.0
  */
 export interface Histogram<Input> extends Metric<Input, HistogramState> {
@@ -784,7 +784,7 @@ export interface Histogram<Input> extends Metric<Input, HistogramState> {
  * })
  * ```
  *
- * @category Metrics
+ * @category metrics
  * @since 4.0.0
  */
 export interface HistogramState {
@@ -889,7 +889,7 @@ export interface HistogramState {
  * })
  * ```
  *
- * @category Metrics
+ * @category metrics
  * @since 2.0.0
  */
 export interface Summary<Input> extends Metric<Input, SummaryState> {
@@ -971,7 +971,7 @@ export interface Summary<Input> extends Metric<Input, SummaryState> {
  * })
  * ```
  *
- * @category Metrics
+ * @category metrics
  * @since 4.0.0
  */
 export interface SummaryState {
@@ -2567,7 +2567,7 @@ export declare const timer: (name: string, options?: {
  * })
  * ```
  *
- * @category utils
+ * @category getters
  * @since 2.0.0
  */
 export declare const value: <Input, State>(self: Metric<Input, State>) => Effect<State>;
@@ -2612,7 +2612,7 @@ export declare const value: <Input, State>(self: Metric<Input, State>) => Effect
  * })
  * ```
  *
- * @category utils
+ * @category mutations
  * @since 3.6.5
  */
 export declare const modify: {
@@ -2657,7 +2657,7 @@ export declare const modify: {
      * })
      * ```
      *
-     * @category utils
+     * @category mutations
      * @since 3.6.5
      */
     <Input>(input: Input): <State>(self: Metric<Input, State>) => Effect<void>;
@@ -2702,7 +2702,7 @@ export declare const modify: {
      * })
      * ```
      *
-     * @category utils
+     * @category mutations
      * @since 3.6.5
      */
     <Input, State>(self: Metric<Input, State>, input: Input): Effect<void>;
@@ -2757,7 +2757,7 @@ export declare const modify: {
  * })
  * ```
  *
- * @category utils
+ * @category mutations
  * @since 2.0.0
  */
 export declare const update: {
@@ -2811,7 +2811,7 @@ export declare const update: {
      * })
      * ```
      *
-     * @category utils
+     * @category mutations
      * @since 2.0.0
      */
     <Input>(input: Input): <State>(self: Metric<Input, State>) => Effect<void>;
@@ -2865,7 +2865,7 @@ export declare const update: {
      * })
      * ```
      *
-     * @category utils
+     * @category mutations
      * @since 2.0.0
      */
     <Input, State>(self: Metric<Input, State>, input: Input): Effect<void>;

package/dist/Metric.js

@@ -1057,7 +1057,7 @@ export const timer = (name, options) => {
  * })
  * ```
  *
- * @category utils
+ * @category getters
  * @since 2.0.0
  */
 export const value = self => InternalEffect.flatMap(InternalEffect.context(), context => InternalEffect.sync(() => self.valueUnsafe(context)));
@@ -1102,7 +1102,7 @@ export const value = self => InternalEffect.flatMap(InternalEffect.context(), co
  * })
  * ```
  *
- * @category utils
+ * @category mutations
  * @since 3.6.5
  */
 export const modify = /*#__PURE__*/dual(2, (self, input) => InternalEffect.flatMap(InternalEffect.context(), context => InternalEffect.sync(() => self.modifyUnsafe(input, context))));
@@ -1156,7 +1156,7 @@ export const modify = /*#__PURE__*/dual(2, (self, input) => InternalEffect.flatM
  * })
  * ```
  *
- * @category utils
+ * @category mutations
  * @since 2.0.0
  */
 export const update = /*#__PURE__*/dual(2, (self, input) => InternalEffect.contextWith(services => InternalEffect.sync(() => self.updateUnsafe(input, services))));