effect 4.0.0-beta.72 → 4.0.0-beta.74

package/dist/Ref.js

@@ -216,7 +216,7 @@ export const set = /*#__PURE__*/dual(2, (self, value) => Effect.sync(() => Mutab
  * @see {@link set} for setting without returning the previous value
  * @see {@link getAndUpdate} for deriving the new value from the previous value
  *
- * @category utils
+ * @category mutations
  * @since 2.0.0
  */
 export const getAndSet = /*#__PURE__*/dual(2, (self, value) => Effect.sync(() => {
@@ -251,7 +251,7 @@ export const getAndSet = /*#__PURE__*/dual(2, (self, value) => Effect.sync(() =>
  * @see {@link update} for updating without returning the previous value
  * @see {@link updateAndGet} for returning the new value instead
  *
- * @category utils
+ * @category mutations
  * @since 2.0.0
  */
 export const getAndUpdate = /*#__PURE__*/dual(2, (self, f) => Effect.sync(() => {
@@ -305,7 +305,7 @@ export const getAndUpdate = /*#__PURE__*/dual(2, (self, f) => Effect.sync(() =>
  * @see {@link getAndUpdate} for always applying an update
  * @see {@link updateSome} for conditional updates without returning the previous value
  *
- * @category utils
+ * @category mutations
  * @since 2.0.0
  */
 export const getAndUpdateSome = /*#__PURE__*/dual(2, (self, pf) => Effect.sync(() => {
@@ -350,7 +350,7 @@ export const getAndUpdateSome = /*#__PURE__*/dual(2, (self, pf) => Effect.sync((
  * })
  * ```
  *
- * @category utils
+ * @category mutations
  * @since 2.0.0
  */
 export const setAndGet = /*#__PURE__*/dual(2, (self, value) => Effect.sync(() => self.ref.current = value));
@@ -542,7 +542,7 @@ export const update = /*#__PURE__*/dual(2, (self, f) => Effect.sync(() => {
  * @see {@link update} for updating without returning the new value
  * @see {@link getAndUpdate} for returning the previous value instead
  *
- * @category utils
+ * @category mutations
  * @since 2.0.0
  */
 export const updateAndGet = /*#__PURE__*/dual(2, (self, f) => Effect.sync(() => self.ref.current = f(self.ref.current)));
@@ -639,7 +639,7 @@ export const updateSome = /*#__PURE__*/dual(2, (self, f) => Effect.sync(() => {
  * @see {@link updateSome} for conditional updates without returning a value
  * @see {@link updateAndGet} for always updating and returning the new value
  *
- * @category utils
+ * @category mutations
  * @since 2.0.0
  */
 export const updateSomeAndGet = /*#__PURE__*/dual(2, (self, pf) => Effect.sync(() => {

package/dist/RegExp.d.ts

@@ -60,7 +60,7 @@ export declare const isRegExp: (input: unknown) => input is RegExp;
  * assert.deepStrictEqual(RegExp.escape("a*b"), "a\\*b")
  * ```
  *
- * @category utils
+ * @category RegExp
  * @since 2.0.0
  */
 export declare const escape: (string: string) => string;

package/dist/RegExp.js

@@ -99,7 +99,7 @@ export const isRegExp = predicate.isRegExp;
  * assert.deepStrictEqual(RegExp.escape("a*b"), "a\\*b")
  * ```
  *
- * @category utils
+ * @category RegExp
  * @since 2.0.0
  */
 export const escape = string => string.replace(/[/\\^$*+?.()|[\]{}]/g, "\\$&");

package/dist/Request.d.ts

@@ -159,7 +159,7 @@ export interface Constructor<R extends Request<any, any, any>, T extends keyof R
  * type UserError = Request.Error<GetUser> // Error
  * ```
  *
- * @category type-level
+ * @category utility types
  * @since 2.0.0
  */
 export type Error<T extends Request<any, any, any>> = [T] extends [Request<infer _A, infer _E, infer _R>] ? _E : never;
@@ -180,14 +180,14 @@ export type Error<T extends Request<any, any, any>> = [T] extends [Request<infer
  * type UserSuccess = Request.Success<GetUser> // string
  * ```
  *
- * @category type-level
+ * @category utility types
  * @since 2.0.0
  */
 export type Success<T extends Request<any, any, any>> = [T] extends [Request<infer _A, infer _E, infer _R>] ? _A : never;
 /**
  * A utility type to extract the requirements type from a `Request`.
  *
- * @category type-level
+ * @category utility types
  * @since 4.0.0
  */
 export type Services<T extends Request<any, any, any>> = [T] extends [Request<infer _A, infer _E, infer _R>] ? _R : never;
@@ -208,7 +208,7 @@ export type Services<T extends Request<any, any, any>> = [T] extends [Request<in
  * type UserResult = Request.Result<GetUser> // Exit.Exit<string, Error>
  * ```
  *
- * @category type-level
+ * @category utility types
  * @since 2.0.0
  */
 export type Result<T extends Request<any, any, any>> = T extends Request<infer A, infer E, infer _R> ? Exit.Exit<A, E> : never;

package/dist/RequestResolver.d.ts

@@ -1345,7 +1345,7 @@ export declare const withSpan: {
  * @see {@link persisted} for storing persistable request results outside process memory
  * @see {@link Cache.Cache} for operations available on the returned cache
  *
- * @category Caching
+ * @category caching
  * @since 4.0.0
  */
 export declare const asCache: {
@@ -1373,7 +1373,7 @@ export declare const asCache: {
      * @see {@link persisted} for storing persistable request results outside process memory
      * @see {@link Cache.Cache} for operations available on the returned cache
      *
-     * @category Caching
+     * @category caching
      * @since 4.0.0
      */
     <A extends Request.Any, ServiceMode extends "lookup" | "construction" = never>(options: {
@@ -1405,7 +1405,7 @@ export declare const asCache: {
      * @see {@link persisted} for storing persistable request results outside process memory
      * @see {@link Cache.Cache} for operations available on the returned cache
      *
-     * @category Caching
+     * @category caching
      * @since 4.0.0
      */
     <A extends Request.Any, ServiceMode extends "lookup" | "construction" = never>(self: RequestResolver<A>, options: {
@@ -1437,7 +1437,7 @@ export declare const asCache: {
  * @see {@link asCache} for exposing the resolver as a `Cache` with time-to-live and service lookup controls
  * @see {@link persisted} for backing persistable requests with the configured persistence store
  *
- * @category Caching
+ * @category caching
  * @since 4.0.0
  */
 export declare const withCache: {
@@ -1464,7 +1464,7 @@ export declare const withCache: {
      * @see {@link asCache} for exposing the resolver as a `Cache` with time-to-live and service lookup controls
      * @see {@link persisted} for backing persistable requests with the configured persistence store
      *
-     * @category Caching
+     * @category caching
      * @since 4.0.0
      */
     <A extends Request.Any>(options: {
@@ -1494,7 +1494,7 @@ export declare const withCache: {
      * @see {@link asCache} for exposing the resolver as a `Cache` with time-to-live and service lookup controls
      * @see {@link persisted} for backing persistable requests with the configured persistence store
      *
-     * @category Caching
+     * @category caching
      * @since 4.0.0
      */
     <A extends Request.Any>(self: RequestResolver<A>, options: {

package/dist/RequestResolver.js

@@ -740,7 +740,7 @@ export const withSpan = /*#__PURE__*/dual(args => isRequestResolver(args[0]), (s
  * @see {@link persisted} for storing persistable request results outside process memory
  * @see {@link Cache.Cache} for operations available on the returned cache
  *
- * @category Caching
+ * @category caching
  * @since 4.0.0
  */
 export const asCache = /*#__PURE__*/dual(2, (self, options) => Cache.makeWith(req => internal.request(req, self), {
@@ -771,7 +771,7 @@ export const asCache = /*#__PURE__*/dual(2, (self, options) => Cache.makeWith(re
  * @see {@link asCache} for exposing the resolver as a `Cache` with time-to-live and service lookup controls
  * @see {@link persisted} for backing persistable requests with the configured persistence store
  *
- * @category Caching
+ * @category caching
  * @since 4.0.0
  */
 export const withCache = /*#__PURE__*/dual(2, (self, options) => Effect.sync(() => {

package/dist/Resource.d.ts

@@ -114,7 +114,7 @@ export declare const get: <A, E>(self: Resource<A, E>) => Effect.Effect<A, E>;
  * @see {@link manual} for resources refreshed only by caller action
  * @see {@link auto} for schedule-driven automatic refreshes
  *
- * @category utils
+ * @category resource management
  * @since 2.0.0
  */
 export declare const refresh: <A, E>(self: Resource<A, E>) => Effect.Effect<void, E>;

package/dist/Resource.js

@@ -146,7 +146,7 @@ export const get = self => Effect.flatMap(ScopedRef.get(self.scopedRef), identit
  * @see {@link manual} for resources refreshed only by caller action
  * @see {@link auto} for schedule-driven automatic refreshes
  *
- * @category utils
+ * @category resource management
  * @since 2.0.0
  */
 export const refresh = self => ScopedRef.set(self.scopedRef, Effect.map(self.acquire, Exit.succeed));

package/dist/Result.d.ts

@@ -252,7 +252,7 @@ export interface ResultUnifyIgnore {
  * (e.g., `map`, `flatMap` abstractions). You typically do not need to
  * reference this directly.
  *
- * @category Type Lambdas
+ * @category type lambdas
  * @since 4.0.0
  */
 export interface ResultTypeLambda extends TypeLambda {
@@ -695,7 +695,7 @@ try_ as try };
  *
  * @see {@link isSuccess} / {@link isFailure} to narrow to a specific variant
  *
- * @category Type Guards
+ * @category guards
  * @since 4.0.0
  */
 export declare const isResult: (input: unknown) => input is Result<unknown, unknown>;
@@ -727,7 +727,7 @@ export declare const isResult: (input: unknown) => input is Result<unknown, unkn
  * @see {@link isSuccess} for the opposite check
  * @see {@link isResult} to check if a value is any Result
  *
- * @category Type Guards
+ * @category guards
  * @since 4.0.0
  */
 export declare const isFailure: <A, E>(self: Result<A, E>) => self is Failure<A, E>;
@@ -759,7 +759,7 @@ export declare const isFailure: <A, E>(self: Result<A, E>) => self is Failure<A,
  * @see {@link isFailure} for the opposite check
  * @see {@link isResult} to check if a value is any Result
  *
- * @category Type Guards
+ * @category guards
  * @since 4.0.0
  */
 export declare const isSuccess: <A, E>(self: Result<A, E>) => self is Success<A, E>;
@@ -851,7 +851,7 @@ export declare const getFailure: <A, E>(self: Result<A, E>) => Option<E>;
  * // Output: false
  * ```
  *
- * @category Equivalence
+ * @category instances
  * @since 4.0.0
  */
 export declare const makeEquivalence: <A, E>(success: Equivalence.Equivalence<A>, failure: Equivalence.Equivalence<E>) => Equivalence.Equivalence<Result<A, E>>;
@@ -1206,7 +1206,7 @@ export declare const map: {
  * @see {@link merge} to extract `A | E` without mapping
  * @see {@link getOrElse} to unwrap only the success with a fallback
  *
- * @category Pattern Matching
+ * @category pattern matching
  * @since 2.0.0
  */
 export declare const match: {
@@ -1240,7 +1240,7 @@ export declare const match: {
      * @see {@link merge} to extract `A | E` without mapping
      * @see {@link getOrElse} to unwrap only the success with a fallback
      *
-     * @category Pattern Matching
+     * @category pattern matching
      * @since 2.0.0
      */
     <E, B, A, C = B>(options: {
@@ -1277,7 +1277,7 @@ export declare const match: {
      * @see {@link merge} to extract `A | E` without mapping
      * @see {@link getOrElse} to unwrap only the success with a fallback
      *
-     * @category Pattern Matching
+     * @category pattern matching
      * @since 2.0.0
      */
     <A, E, B, C = B>(self: Result<A, E>, options: {
@@ -2727,7 +2727,7 @@ export declare const all: <const I extends Iterable<Result<any, any>> | Record<s
  *
  * @see {@link mapError} to transform the error without swapping
  *
- * @category utils
+ * @category transforming
  * @since 2.0.0
  */
 export declare const flip: <A, E>(self: Result<A, E>) => Result<E, A>;
@@ -2764,7 +2764,7 @@ export declare const flip: <A, E>(self: Result<A, E>) => Result<E, A>;
  * @see {@link flatMap} for point-free sequential composition
  * @see {@link all} to collect multiple independent Results
  *
- * @category Generators
+ * @category generators
  * @since 2.0.0
  */
 export declare const gen: Gen.Gen<ResultTypeLambda>;
@@ -2803,7 +2803,7 @@ export declare const gen: Gen.Gen<ResultTypeLambda>;
  * @see {@link gen} for an alternative generator-based syntax
  * @see {@link bindTo} for starting a do-notation chain from an existing Result
  *
- * @category Do Notation
+ * @category do notation
  * @since 2.0.0
  */
 export declare const Do: Result<{}>;
@@ -2840,7 +2840,7 @@ export declare const Do: Result<{}>;
  * @see {@link let_ let} for pure computed fields
  * @see {@link bindTo} to wrap an initial Result into a named field
  *
- * @category Do Notation
+ * @category do notation
  * @since 2.0.0
  */
 export declare const bind: {
@@ -2877,7 +2877,7 @@ export declare const bind: {
      * @see {@link let_ let} for pure computed fields
      * @see {@link bindTo} to wrap an initial Result into a named field
      *
-     * @category Do Notation
+     * @category do notation
      * @since 2.0.0
      */
     <N extends string, A extends object, B, L2>(name: Exclude<N, keyof A>, f: (a: NoInfer<A>) => Result<B, L2>): <L1>(self: Result<A, L1>) => Result<{
@@ -2916,7 +2916,7 @@ export declare const bind: {
      * @see {@link let_ let} for pure computed fields
      * @see {@link bindTo} to wrap an initial Result into a named field
      *
-     * @category Do Notation
+     * @category do notation
      * @since 2.0.0
      */
     <A extends object, L1, N extends string, B, L2>(self: Result<A, L1>, name: Exclude<N, keyof A>, f: (a: NoInfer<A>) => Result<B, L2>): Result<{
@@ -2953,7 +2953,7 @@ export declare const bind: {
  * @see {@link Do} to start from an empty object
  * @see {@link bind} to add more fields
  *
- * @category Do Notation
+ * @category do notation
  * @since 2.0.0
  */
 export declare const bindTo: {
@@ -2987,7 +2987,7 @@ export declare const bindTo: {
      * @see {@link Do} to start from an empty object
      * @see {@link bind} to add more fields
      *
-     * @category Do Notation
+     * @category do notation
      * @since 2.0.0
      */
     <N extends string>(name: N): <R, L>(self: Result<R, L>) => Result<Record<N, R>, L>;
@@ -3021,7 +3021,7 @@ export declare const bindTo: {
      * @see {@link Do} to start from an empty object
      * @see {@link bind} to add more fields
      *
-     * @category Do Notation
+     * @category do notation
      * @since 2.0.0
      */
     <R, L, N extends string>(self: Result<R, L>, name: N): Result<Record<N, R>, L>;
@@ -3066,7 +3066,7 @@ export {
  * @see {@link Do} to start the do-notation chain
  * @see {@link bind} for Result-producing fields
  *
- * @category Do Notation
+ * @category do notation
  * @since 2.0.0
  */
 let_ as let };

package/dist/Result.js

@@ -339,7 +339,7 @@ try_ as try };
  *
  * @see {@link isSuccess} / {@link isFailure} to narrow to a specific variant
  *
- * @category Type Guards
+ * @category guards
  * @since 4.0.0
  */
 export const isResult = result.isResult;
@@ -371,7 +371,7 @@ export const isResult = result.isResult;
  * @see {@link isSuccess} for the opposite check
  * @see {@link isResult} to check if a value is any Result
  *
- * @category Type Guards
+ * @category guards
  * @since 4.0.0
  */
 export const isFailure = result.isFailure;
@@ -403,7 +403,7 @@ export const isFailure = result.isFailure;
  * @see {@link isFailure} for the opposite check
  * @see {@link isResult} to check if a value is any Result
  *
- * @category Type Guards
+ * @category guards
  * @since 4.0.0
  */
 export const isSuccess = result.isSuccess;
@@ -495,7 +495,7 @@ export const getFailure = result.getFailure;
  * // Output: false
  * ```
  *
- * @category Equivalence
+ * @category instances
  * @since 4.0.0
  */
 export const makeEquivalence = (success, failure) => Equivalence.make((x, y) => isFailure(x) ? isFailure(y) && failure(x.failure, y.failure) : isSuccess(y) && success(x.success, y.success));
@@ -636,7 +636,7 @@ export const map = /*#__PURE__*/dual(2, (self, f) => isSuccess(self) ? succeed(f
  * @see {@link merge} to extract `A | E` without mapping
  * @see {@link getOrElse} to unwrap only the success with a fallback
  *
- * @category Pattern Matching
+ * @category pattern matching
  * @since 2.0.0
  */
 export const match = /*#__PURE__*/dual(2, (self, {
@@ -1132,7 +1132,7 @@ export const all = input => {
  *
  * @see {@link mapError} to transform the error without swapping
  *
- * @category utils
+ * @category transforming
  * @since 2.0.0
  */
 export const flip = self => isFailure(self) ? succeed(self.failure) : fail(self.success);
@@ -1169,7 +1169,7 @@ export const flip = self => isFailure(self) ? succeed(self.failure) : fail(self.
  * @see {@link flatMap} for point-free sequential composition
  * @see {@link all} to collect multiple independent Results
  *
- * @category Generators
+ * @category generators
  * @since 2.0.0
  */
 export const gen = (...args) => {
@@ -1223,7 +1223,7 @@ export const gen = (...args) => {
  * @see {@link gen} for an alternative generator-based syntax
  * @see {@link bindTo} for starting a do-notation chain from an existing Result
  *
- * @category Do Notation
+ * @category do notation
  * @since 2.0.0
  */
 export const Do = /*#__PURE__*/succeed({});
@@ -1260,7 +1260,7 @@ export const Do = /*#__PURE__*/succeed({});
  * @see {@link let_ let} for pure computed fields
  * @see {@link bindTo} to wrap an initial Result into a named field
  *
- * @category Do Notation
+ * @category do notation
  * @since 2.0.0
  */
 export const bind = /*#__PURE__*/doNotation.bind(map, flatMap);
@@ -1294,7 +1294,7 @@ export const bind = /*#__PURE__*/doNotation.bind(map, flatMap);
  * @see {@link Do} to start from an empty object
  * @see {@link bind} to add more fields
  *
- * @category Do Notation
+ * @category do notation
  * @since 2.0.0
  */
 export const bindTo = /*#__PURE__*/doNotation.bindTo(map);
@@ -1331,7 +1331,7 @@ export {
  * @see {@link Do} to start the do-notation chain
  * @see {@link bind} for Result-producing fields
  *
- * @category Do Notation
+ * @category do notation
  * @since 2.0.0
  */
 let_ as let };