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

package/src/Request.ts

@@ -169,7 +169,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
@@ -191,7 +191,7 @@ 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
@@ -200,7 +200,7 @@ export type Success<T extends Request<any, any, any>> = [T] extends [Request<inf
 /**
  * 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
@@ -223,7 +223,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>
@@ -449,8 +449,8 @@ export const TaggedClass = <Tag extends string>(
  *
  * **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
@@ -466,8 +466,8 @@ export 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
@@ -483,8 +483,8 @@ export 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
@@ -649,8 +649,8 @@ export 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`
@@ -666,8 +666,8 @@ export 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`
@@ -683,8 +683,8 @@ export 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`
@@ -706,8 +706,8 @@ export 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
@@ -723,8 +723,8 @@ export 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
@@ -740,8 +740,8 @@ export 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/src/RequestResolver.ts

@@ -1595,7 +1595,7 @@ export 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 const asCache: {
@@ -1623,7 +1623,7 @@ export 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
    */
   <
@@ -1669,7 +1669,7 @@ export 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
    */
   <
@@ -1738,7 +1738,7 @@ export 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 const withCache: {
@@ -1765,7 +1765,7 @@ export 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>(
@@ -1797,7 +1797,7 @@ export 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>(
@@ -1836,7 +1836,7 @@ export 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, /**
@@ -1862,7 +1862,7 @@ export 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
      */
     {

package/src/Resource.ts

@@ -113,8 +113,8 @@ const makeUnsafe = <A, E>(
  *
  * **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
@@ -202,7 +202,7 @@ export 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 const refresh = <A, E>(self: Resource<A, E>): Effect.Effect<void, E> =>