effect 4.0.0-beta.73 → 4.0.0-beta.75

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;
@@ -391,8 +391,8 @@ export declare const TaggedClass: <Tag extends string>(tag: Tag) => new <A exten
  *
  * **When to use**
  *
- * Use to finish a `Request.Entry` when you already have the request's final
- * `Exit` result.
+ * Use when you need to finish a `Request.Entry` with a prebuilt final `Exit`
+ * result.
  *
  * @see {@link completeEffect} for completing an entry from an effect that may succeed or fail
  * @see {@link succeed} for completing an entry with a successful value
@@ -408,8 +408,8 @@ export declare const complete: {
      *
      * **When to use**
      *
-     * Use to finish a `Request.Entry` when you already have the request's final
-     * `Exit` result.
+     * Use when you need to finish a `Request.Entry` with a prebuilt final `Exit`
+     * result.
      *
      * @see {@link completeEffect} for completing an entry from an effect that may succeed or fail
      * @see {@link succeed} for completing an entry with a successful value
@@ -425,8 +425,8 @@ export declare const complete: {
      *
      * **When to use**
      *
-     * Use to finish a `Request.Entry` when you already have the request's final
-     * `Exit` result.
+     * Use when you need to finish a `Request.Entry` with a prebuilt final `Exit`
+     * result.
      *
      * @see {@link completeEffect} for completing an entry from an effect that may succeed or fail
      * @see {@link succeed} for completing an entry with a successful value
@@ -574,8 +574,8 @@ export declare const fail: {
  *
  * **When to use**
  *
- * Use when a `RequestResolver` needs to complete an entry with structured cause
- * information rather than only the request's typed error value.
+ * Use when you need a `RequestResolver` to complete an entry with structured
+ * cause information rather than only the request's typed error value.
  *
  * @see {@link fail} for completing an entry with a typed error value
  * @see {@link complete} for completing an entry with an existing `Exit`
@@ -591,8 +591,8 @@ export declare const failCause: {
      *
      * **When to use**
      *
-     * Use when a `RequestResolver` needs to complete an entry with structured cause
-     * information rather than only the request's typed error value.
+     * Use when you need a `RequestResolver` to complete an entry with structured
+     * cause information rather than only the request's typed error value.
      *
      * @see {@link fail} for completing an entry with a typed error value
      * @see {@link complete} for completing an entry with an existing `Exit`
@@ -608,8 +608,8 @@ export declare const failCause: {
      *
      * **When to use**
      *
-     * Use when a `RequestResolver` needs to complete an entry with structured cause
-     * information rather than only the request's typed error value.
+     * Use when you need a `RequestResolver` to complete an entry with structured
+     * cause information rather than only the request's typed error value.
      *
      * @see {@link fail} for completing an entry with a typed error value
      * @see {@link complete} for completing an entry with an existing `Exit`
@@ -626,8 +626,8 @@ export declare const failCause: {
  *
  * **When to use**
  *
- * Use to finish a `Request.Entry` when you have a successful value for the
- * request.
+ * Use when you need to finish a `Request.Entry` with a successful request
+ * value.
  *
  * @see {@link complete} for completing an entry with a prebuilt `Exit`
  * @see {@link completeEffect} for completing an entry from an effect result
@@ -643,8 +643,8 @@ export declare const succeed: {
      *
      * **When to use**
      *
-     * Use to finish a `Request.Entry` when you have a successful value for the
-     * request.
+     * Use when you need to finish a `Request.Entry` with a successful request
+     * value.
      *
      * @see {@link complete} for completing an entry with a prebuilt `Exit`
      * @see {@link completeEffect} for completing an entry from an effect result
@@ -660,8 +660,8 @@ export declare const succeed: {
      *
      * **When to use**
      *
-     * Use to finish a `Request.Entry` when you have a successful value for the
-     * request.
+     * Use when you need to finish a `Request.Entry` with a successful request
+     * value.
      *
      * @see {@link complete} for completing an entry with a prebuilt `Exit`
      * @see {@link completeEffect} for completing an entry from an effect result

package/dist/Request.js

@@ -205,8 +205,8 @@ export const TaggedClass = tag => {
  *
  * **When to use**
  *
- * Use to finish a `Request.Entry` when you already have the request's final
- * `Exit` result.
+ * Use when you need to finish a `Request.Entry` with a prebuilt final `Exit`
+ * result.
  *
  * @see {@link completeEffect} for completing an entry from an effect that may succeed or fail
  * @see {@link succeed} for completing an entry with a successful value
@@ -268,8 +268,8 @@ export const fail = /*#__PURE__*/dual(2, (self, error) => complete(self, core.ex
  *
  * **When to use**
  *
- * Use when a `RequestResolver` needs to complete an entry with structured cause
- * information rather than only the request's typed error value.
+ * Use when you need a `RequestResolver` to complete an entry with structured
+ * cause information rather than only the request's typed error value.
  *
  * @see {@link fail} for completing an entry with a typed error value
  * @see {@link complete} for completing an entry with an existing `Exit`
@@ -285,8 +285,8 @@ export const failCause = /*#__PURE__*/dual(2, (self, cause) => complete(self, co
  *
  * **When to use**
  *
- * Use to finish a `Request.Entry` when you have a successful value for the
- * request.
+ * Use when you need to finish a `Request.Entry` with a successful request
+ * value.
  *
  * @see {@link complete} for completing an entry with a prebuilt `Exit`
  * @see {@link completeEffect} for completing an entry from an effect result

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

@@ -48,8 +48,8 @@ export declare const isResource: (u: unknown) => u is Resource<unknown, unknown>
  *
  * **When to use**
  *
- * Use when you need to control the timing of resource refreshes yourself rather
- * than relying on an automatic schedule.
+ * Use when you need manual control over resource refresh timing rather than an
+ * automatic schedule.
  *
  * @see {@link auto} for schedule-driven automatic refreshes
  * @see {@link refresh} to manually trigger a resource refresh
@@ -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

@@ -77,8 +77,8 @@ const makeUnsafe = (scopedRef, acquire) => {
  *
  * **When to use**
  *
- * Use when you need to control the timing of resource refreshes yourself rather
- * than relying on an automatic schedule.
+ * Use when you need manual control over resource refresh timing rather than an
+ * automatic schedule.
  *
  * @see {@link auto} for schedule-driven automatic refreshes
  * @see {@link refresh} to manually trigger a resource refresh
@@ -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));