effect 4.0.0-beta.71 → 4.0.0-beta.73

package/src/Ref.ts

@@ -360,7 +360,7 @@ export const set = dual<
 >(2, <A>(self: Ref<A>, value: A) => Effect.sync(() => MutableRef.set(self.ref, value)))
 
 /**
- * Atomically gets the current value of the Ref, sets it to the specified value, and returns the previous value.
+ * Gets the current value of the Ref, sets it to the specified value, and returns the previous value atomically.
  *
  * **When to use**
  *
@@ -391,7 +391,7 @@ export const set = dual<
  */
 export const getAndSet = dual<
   /**
-   * Atomically gets the current value of the Ref, sets it to the specified value, and returns the previous value.
+   * Gets the current value of the Ref, sets it to the specified value, and returns the previous value atomically.
    *
    * **When to use**
    *
@@ -422,7 +422,7 @@ export const getAndSet = dual<
    */
   <A>(value: A) => (self: Ref<A>) => Effect.Effect<A>,
   /**
-   * Atomically gets the current value of the Ref, sets it to the specified value, and returns the previous value.
+   * Gets the current value of the Ref, sets it to the specified value, and returns the previous value atomically.
    *
    * **When to use**
    *
@@ -460,7 +460,7 @@ export const getAndSet = dual<
   }))
 
 /**
- * Atomically gets the current value of the Ref, updates it with the given function, and returns the previous value.
+ * Gets the current value of the Ref, updates it with the given function, and returns the previous value atomically.
  *
  * **When to use**
  *
@@ -491,7 +491,7 @@ export const getAndSet = dual<
  */
 export const getAndUpdate = dual<
   /**
-   * Atomically gets the current value of the Ref, updates it with the given function, and returns the previous value.
+   * Gets the current value of the Ref, updates it with the given function, and returns the previous value atomically.
    *
    * **When to use**
    *
@@ -522,7 +522,7 @@ export const getAndUpdate = dual<
    */
   <A>(f: (a: A) => A) => (self: Ref<A>) => Effect.Effect<A>,
   /**
-   * Atomically gets the current value of the Ref, updates it with the given function, and returns the previous value.
+   * Gets the current value of the Ref, updates it with the given function, and returns the previous value atomically.
    *
    * **When to use**
    *
@@ -560,7 +560,7 @@ export const getAndUpdate = dual<
   }))
 
 /**
- * Atomically gets the current value of the Ref and updates it with the given partial function.
+ * Gets the current value of the Ref and updates it atomically with the given partial function.
  *
  * **When to use**
  *
@@ -610,7 +610,7 @@ export const getAndUpdate = dual<
  */
 export const getAndUpdateSome = dual<
   /**
-   * Atomically gets the current value of the Ref and updates it with the given partial function.
+   * Gets the current value of the Ref and updates it atomically with the given partial function.
    *
    * **When to use**
    *
@@ -660,7 +660,7 @@ export const getAndUpdateSome = dual<
    */
   <A>(pf: (a: A) => Option.Option<A>) => (self: Ref<A>) => Effect.Effect<A>,
   /**
-   * Atomically gets the current value of the Ref and updates it with the given partial function.
+   * Gets the current value of the Ref and updates it atomically with the given partial function.
    *
    * **When to use**
    *
@@ -720,7 +720,7 @@ export const getAndUpdateSome = dual<
   }))
 
 /**
- * Atomically sets the value of the Ref to the specified value and returns the new value.
+ * Sets the value of the Ref atomically to the specified value and returns the new value.
  *
  * **When to use**
  *
@@ -758,7 +758,7 @@ export const getAndUpdateSome = dual<
  */
 export const setAndGet = dual<
   /**
-   * Atomically sets the value of the Ref to the specified value and returns the new value.
+   * Sets the value of the Ref atomically to the specified value and returns the new value.
    *
    * **When to use**
    *
@@ -796,7 +796,7 @@ export const setAndGet = dual<
    */
   <A>(value: A) => (self: Ref<A>) => Effect.Effect<A>,
   /**
-   * Atomically sets the value of the Ref to the specified value and returns the new value.
+   * Sets the value of the Ref atomically to the specified value and returns the new value.
    *
    * **When to use**
    *
@@ -836,7 +836,7 @@ export const setAndGet = dual<
 >(2, <A>(self: Ref<A>, value: A) => Effect.sync(() => self.ref.current = value))
 
 /**
- * Atomically modifies the value of the Ref using the given function.
+ * Modifies the value of the Ref atomically using the given function.
  *
  * **When to use**
  *
@@ -890,7 +890,7 @@ export const setAndGet = dual<
  */
 export const modify = dual<
   /**
-   * Atomically modifies the value of the Ref using the given function.
+   * Modifies the value of the Ref atomically using the given function.
    *
    * **When to use**
    *
@@ -944,7 +944,7 @@ export const modify = dual<
    */
   <A, B>(f: (a: A) => readonly [B, A]) => (self: Ref<A>) => Effect.Effect<B>,
   /**
-   * Atomically modifies the value of the Ref using the given function.
+   * Modifies the value of the Ref atomically using the given function.
    *
    * **When to use**
    *
@@ -1005,7 +1005,7 @@ export const modify = dual<
   }))
 
 /**
- * Atomically computes a result and optionally updates the value of the `Ref`.
+ * Computes a result atomically and optionally updates the value of the `Ref`.
  *
  * **When to use**
  *
@@ -1064,7 +1064,7 @@ export const modify = dual<
  */
 export const modifySome: {
   /**
-   * Atomically computes a result and optionally updates the value of the `Ref`.
+   * Computes a result atomically and optionally updates the value of the `Ref`.
    *
    * **When to use**
    *
@@ -1123,7 +1123,7 @@ export const modifySome: {
    */
   <B, A>(pf: (a: A) => readonly [B, Option.Option<A>]): (self: Ref<A>) => Effect.Effect<B>
   /**
-   * Atomically computes a result and optionally updates the value of the `Ref`.
+   * Computes a result atomically and optionally updates the value of the `Ref`.
    *
    * **When to use**
    *
@@ -1183,7 +1183,7 @@ export const modifySome: {
   <A, B>(self: Ref<A>, pf: (a: A) => readonly [B, Option.Option<A>]): Effect.Effect<B>
 } = dual<
   /**
-   * Atomically computes a result and optionally updates the value of the `Ref`.
+   * Computes a result atomically and optionally updates the value of the `Ref`.
    *
    * **When to use**
    *
@@ -1242,7 +1242,7 @@ export const modifySome: {
    */
   <B, A>(pf: (a: A) => readonly [B, Option.Option<A>]) => (self: Ref<A>) => Effect.Effect<B>,
   /**
-   * Atomically computes a result and optionally updates the value of the `Ref`.
+   * Computes a result atomically and optionally updates the value of the `Ref`.
    *
    * **When to use**
    *
@@ -1307,7 +1307,7 @@ export const modifySome: {
   }))
 
 /**
- * Atomically updates the value of the Ref using the given function.
+ * Updates the value of the Ref atomically using the given function.
  *
  * **When to use**
  *
@@ -1345,7 +1345,7 @@ export const modifySome: {
  */
 export const update = dual<
   /**
-   * Atomically updates the value of the Ref using the given function.
+   * Updates the value of the Ref atomically using the given function.
    *
    * **When to use**
    *
@@ -1383,7 +1383,7 @@ export const update = dual<
    */
   <A>(f: (a: A) => A) => (self: Ref<A>) => Effect.Effect<void>,
   /**
-   * Atomically updates the value of the Ref using the given function.
+   * Updates the value of the Ref atomically using the given function.
    *
    * **When to use**
    *
@@ -1426,7 +1426,7 @@ export const update = dual<
   }))
 
 /**
- * Atomically updates the value of the Ref using the given function and returns the new value.
+ * Updates the value of the Ref atomically using the given function and returns the new value.
  *
  * **When to use**
  *
@@ -1458,7 +1458,7 @@ export const update = dual<
  */
 export const updateAndGet = dual<
   /**
-   * Atomically updates the value of the Ref using the given function and returns the new value.
+   * Updates the value of the Ref atomically using the given function and returns the new value.
    *
    * **When to use**
    *
@@ -1490,7 +1490,7 @@ export const updateAndGet = dual<
    */
   <A>(f: (a: A) => A) => (self: Ref<A>) => Effect.Effect<A>,
   /**
-   * Atomically updates the value of the Ref using the given function and returns the new value.
+   * Updates the value of the Ref atomically using the given function and returns the new value.
    *
    * **When to use**
    *
@@ -1524,7 +1524,7 @@ export const updateAndGet = dual<
 >(2, <A>(self: Ref<A>, f: (a: A) => A) => Effect.sync(() => self.ref.current = f(self.ref.current)))
 
 /**
- * Atomically updates the value of the Ref using the given partial function.
+ * Updates the value of the Ref atomically using the given partial function.
  *
  * **When to use**
  *
@@ -1572,7 +1572,7 @@ export const updateAndGet = dual<
  */
 export const updateSome = dual<
   /**
-   * Atomically updates the value of the Ref using the given partial function.
+   * Updates the value of the Ref atomically using the given partial function.
    *
    * **When to use**
    *
@@ -1620,7 +1620,7 @@ export const updateSome = dual<
    */
   <A>(f: (a: A) => Option.Option<A>) => (self: Ref<A>) => Effect.Effect<void>,
   /**
-   * Atomically updates the value of the Ref using the given partial function.
+   * Updates the value of the Ref atomically using the given partial function.
    *
    * **When to use**
    *
@@ -1676,7 +1676,7 @@ export const updateSome = dual<
   }))
 
 /**
- * Atomically updates the value of the Ref using the given partial function and returns the current value.
+ * Updates the value of the Ref atomically using the given partial function and returns the current value.
  *
  * **When to use**
  *
@@ -1720,7 +1720,7 @@ export const updateSome = dual<
  */
 export const updateSomeAndGet = dual<
   /**
-   * Atomically updates the value of the Ref using the given partial function and returns the current value.
+   * Updates the value of the Ref atomically using the given partial function and returns the current value.
    *
    * **When to use**
    *
@@ -1764,7 +1764,7 @@ export const updateSomeAndGet = dual<
    */
   <A>(pf: (a: A) => Option.Option<A>) => (self: Ref<A>) => Effect.Effect<A>,
   /**
-   * Atomically updates the value of the Ref using the given partial function and returns the current value.
+   * Updates the value of the Ref atomically using the given partial function and returns the current value.
    *
    * **When to use**
    *

package/src/References.ts

@@ -71,7 +71,7 @@ import { CurrentTraceLevel, DisablePropagation, MinimumTraceLevel, type SpanLink
 
 export {
   /**
-   * Reference for the current trace level used for dynamic trace filtering.
+   * Context reference for the current trace level used for dynamic trace filtering.
    *
    * **When to use**
    *
@@ -85,7 +85,7 @@ export {
    */
   CurrentTraceLevel,
   /**
-   * Reference used to disable trace propagation in the current context.
+   * Context reference for disabling trace propagation in the current context.
    *
    * **When to use**
    *
@@ -104,7 +104,7 @@ export {
    */
   DisablePropagation,
   /**
-   * Reference controlling the maximum operation budget before a fiber yields to the scheduler.
+   * Context reference for the maximum operation budget before a fiber yields to the scheduler.
    *
    * **When to use**
    *
@@ -122,7 +122,7 @@ export {
    */
   MaxOpsBeforeYield,
   /**
-   * Reference setting the minimum trace level threshold for span sampling.
+   * Context reference for the minimum trace level threshold for span sampling.
    *
    * **When to use**
    *
@@ -136,7 +136,7 @@ export {
    */
   MinimumTraceLevel,
   /**
-   * Reference controlling whether the runtime bypasses scheduler yield checks.
+   * Context reference for whether the runtime bypasses scheduler yield checks.
    *
    * **When to use**
    *
@@ -160,7 +160,7 @@ export {
    */
   PreventSchedulerYield,
   /**
-   * Reference for the active tracer service used to create spans.
+   * Context reference for the active tracer service used to create spans.
    *
    * **When to use**
    *
@@ -174,7 +174,7 @@ export {
 }
 
 /**
- * Reference for controlling the current concurrency limit. Can be set to "unbounded"
+ * Context reference for controlling the current concurrency limit. Can be set to "unbounded"
  * for unlimited concurrency or a specific number to limit concurrent operations.
  *
  * **When to use**
@@ -220,7 +220,7 @@ export {
 export const CurrentConcurrency: Context.Reference<number | "unbounded"> = references.CurrentConcurrency
 
 /**
- * Reference for managing log annotations that are automatically added to all log entries.
+ * Context reference for managing log annotations that are automatically added to all log entries.
  * These annotations provide contextual metadata that appears in every log message.
  *
  * **When to use**
@@ -283,7 +283,7 @@ export const CurrentLogAnnotations: Context.Reference<ReadonlyRecord<string, unk
   references.CurrentLogAnnotations
 
 /**
- * Reference for the current log severity used by `Effect.log` when no explicit
+ * Context reference for the current log severity used by `Effect.log` when no explicit
  * level is provided.
  *
  * **When to use**
@@ -336,7 +336,7 @@ export const CurrentLogAnnotations: Context.Reference<ReadonlyRecord<string, unk
 export const CurrentLogLevel: Context.Reference<Severity> = references.CurrentLogLevel
 
 /**
- * Reference for managing log spans that track the duration and hierarchy of operations.
+ * Context reference for managing log spans that track the duration and hierarchy of operations.
  * Each span represents a labeled time period for performance analysis and debugging.
  *
  * **When to use**
@@ -404,7 +404,7 @@ export const CurrentLogSpans: Context.Reference<ReadonlyArray<[label: string, ti
   references.CurrentLogSpans
 
 /**
- * Reference containing the current captured stack-frame chain for the running
+ * Context reference for the current captured stack-frame chain for the running
  * fiber.
  *
  * **When to use**
@@ -426,7 +426,7 @@ export const CurrentLogSpans: Context.Reference<ReadonlyArray<[label: string, ti
 export const CurrentStackFrame: Context.Reference<StackFrame | undefined> = references.CurrentStackFrame
 
 /**
- * Reference for setting the minimum log level threshold. Log entries below this
+ * Context reference for setting the minimum log level threshold. Log entries below this
  * level will be filtered out completely.
  *
  * **When to use**
@@ -482,7 +482,7 @@ export const CurrentStackFrame: Context.Reference<StackFrame | undefined> = refe
 export const MinimumLogLevel: Context.Reference<LogLevel> = references.MinimumLogLevel
 
 /**
- * Reference for controlling whether tracing is enabled globally. When set to false,
+ * Context reference for controlling whether tracing is enabled globally. When set to false,
  * spans will not be registered with the tracer and tracing overhead is minimized.
  *
  * **When to use**
@@ -533,7 +533,7 @@ export const MinimumLogLevel: Context.Reference<LogLevel> = references.MinimumLo
 export const TracerEnabled: Context.Reference<boolean> = references.TracerEnabled
 
 /**
- * Reference for managing span annotations that are automatically added to all new spans.
+ * Context reference for managing span annotations that are automatically added to all new spans.
  * These annotations provide context and metadata that applies across multiple spans.
  *
  * **When to use**
@@ -591,7 +591,7 @@ export const TracerSpanAnnotations: Context.Reference<ReadonlyRecord<string, unk
   references.TracerSpanAnnotations
 
 /**
- * Reference for managing span links that are automatically added to all new spans.
+ * Context reference for managing span links that are automatically added to all new spans.
  * Span links connect related spans that are not in a parent-child relationship.
  *
  * **When to use**
@@ -658,7 +658,7 @@ export const TracerSpanAnnotations: Context.Reference<ReadonlyRecord<string, unk
 export const TracerSpanLinks: Context.Reference<ReadonlyArray<SpanLink>> = references.TracerSpanLinks
 
 /**
- * Reference for controlling whether trace timing is enabled globally. When set
+ * Context reference for controlling whether trace timing is enabled globally. When set
  * to false, spans will not contain timing information (trace time will always
  * be set to zero).
  *
@@ -706,7 +706,7 @@ export const TracerSpanLinks: Context.Reference<ReadonlyArray<SpanLink>> = refer
 export const TracerTimingEnabled: Context.Reference<boolean> = references.TracerTimingEnabled
 
 /**
- * Reference for the log severity used when a pool finalizer reports an
+ * Context reference for the log severity used when a pool finalizer reports an
  * unhandled error.
  *
  * **When to use**
@@ -756,7 +756,7 @@ export interface StackFrame {
 }
 
 /**
- * Reference containing the set of loggers currently used by Effect logging
+ * Context reference for the set of loggers currently used by Effect logging
  * operations.
  *
  * **When to use**
@@ -776,7 +776,7 @@ export interface StackFrame {
 export const CurrentLoggers: Context.Reference<ReadonlySet<Logger<unknown, any>>> = internalEffect.CurrentLoggers
 
 /**
- * Reference controlling whether built-in console loggers write to stderr.
+ * Context reference for controlling whether built-in console loggers write to stderr.
  *
  * **When to use**
  *
@@ -795,7 +795,7 @@ export const LogToStderr: Context.Reference<boolean> = internalEffect.LogToStder
 
 export {
   /**
-   * Reference for the current scheduler implementation used by the Effect runtime.
+   * Context reference for the current scheduler implementation used by the Effect runtime.
    * Controls how Effects are scheduled and executed.
    *
    * **When to use**

package/src/RegExp.ts

@@ -39,7 +39,7 @@
 import * as predicate from "./Predicate.ts"
 
 /**
- * Re-exports the JavaScript `RegExp` constructor from `globalThis`.
+ * Exposes the JavaScript regular expression constructor from `globalThis`.
  *
  * **When to use**
  *
@@ -65,7 +65,7 @@ import * as predicate from "./Predicate.ts"
 export const RegExp = globalThis.RegExp
 
 /**
- * Tests if a value is a `RegExp`.
+ * Checks whether a value is a `RegExp`.
  *
  * **When to use**
  *

package/src/Request.ts

@@ -248,7 +248,7 @@ const requestVariance = Equal.byReferenceUnsafe({
  * `Request.TaggedClass`. Most users should use those constructors instead of
  * interacting with the prototype directly.
  *
- * @category models
+ * @category prototypes
  * @since 4.0.0
  */
 export const RequestPrototype: Request<any, any, any> = {
@@ -257,7 +257,7 @@ export const RequestPrototype: Request<any, any, any> = {
 }
 
 /**
- * Tests if a value is a `Request`.
+ * Checks whether a value is a `Request`.
  *
  * **Example** (Checking request values)
  *
@@ -370,7 +370,7 @@ export const tagged = <R extends Request<any, any, any> & { _tag: string }>(
 }
 
 /**
- * Base class constructor for defining request types with TypeScript classes.
+ * Defines request types with TypeScript classes.
  *
  * **Details**
  *

package/src/RequestResolver.ts

@@ -186,7 +186,7 @@ const RequestResolverProto = {
 export const isRequestResolver = (u: unknown): u is RequestResolver<any> => hasProperty(u, TypeId)
 
 /**
- * Low-level constructor for creating a request resolver with fine-grained
+ * Creates a request resolver with fine-grained
  * control over its behavior.
  *
  * **When to use**
@@ -784,8 +784,7 @@ export const setDelay: {
 )
 
 /**
- * A request resolver aspect that executes requests between two effects, `before`
- * and `after`, where the result of `before` can be used by `after`.
+ * Wraps request resolver execution between `before` and `after` effects.
  *
  * **Example** (Running effects around request resolution)
  *
@@ -827,8 +826,7 @@ export const setDelay: {
  */
 export const around: {
   /**
-   * A request resolver aspect that executes requests between two effects, `before`
-   * and `after`, where the result of `before` can be used by `after`.
+   * Wraps request resolver execution between `before` and `after` effects.
    *
    * **Example** (Running effects around request resolution)
    *
@@ -873,8 +871,7 @@ export const around: {
     after: (entries: NonEmptyArray<Request.Entry<NoInfer<A>>>, a: A2) => Effect.Effect<X, Request.Error<A>>
   ): (self: RequestResolver<A>) => RequestResolver<A>
   /**
-   * A request resolver aspect that executes requests between two effects, `before`
-   * and `after`, where the result of `before` can be used by `after`.
+   * Wraps request resolver execution between `before` and `after` effects.
    *
    * **Example** (Running effects around request resolution)
    *
@@ -935,7 +932,7 @@ export const around: {
   }))
 
 /**
- * A request resolver that never executes requests.
+ * Creates a request resolver that never executes requests.
  *
  * **When to use**
  *
@@ -1093,7 +1090,7 @@ export const batchN: {
   }))
 
 /**
- * Transform a request resolver by grouping requests using the specified key
+ * Transforms a request resolver by grouping requests using the specified key
  * function.
  *
  * **Example** (Grouping resolver requests)
@@ -1145,7 +1142,7 @@ export const batchN: {
  */
 export const grouped: {
   /**
-   * Transform a request resolver by grouping requests using the specified key
+   * Transforms a request resolver by grouping requests using the specified key
    * function.
    *
    * **Example** (Grouping resolver requests)
@@ -1197,7 +1194,7 @@ export const grouped: {
    */
   <A extends Request.Any, K>(f: (entry: Request.Entry<A>) => K): (self: RequestResolver<A>) => RequestResolver<A>
   /**
-   * Transform a request resolver by grouping requests using the specified key
+   * Transforms a request resolver by grouping requests using the specified key
    * function.
    *
    * **Example** (Grouping resolver requests)
@@ -1410,7 +1407,7 @@ export const race: {
   ))
 
 /**
- * Add a tracing span to the request resolver, which will also add any span
+ * Adds a tracing span to the request resolver, which will also add any span
  * links from the request's.
  *
  * **Example** (Adding a tracing span)
@@ -1453,7 +1450,7 @@ export const race: {
  */
 export const withSpan: {
   /**
-   * Add a tracing span to the request resolver, which will also add any span
+   * Adds a tracing span to the request resolver, which will also add any span
    * links from the request's.
    *
    * **Example** (Adding a tracing span)
@@ -1499,7 +1496,7 @@ export const withSpan: {
     options?: Tracer.SpanOptions | ((entries: NonEmptyArray<Request.Entry<A>>) => Tracer.SpanOptions) | undefined
   ): (self: RequestResolver<A>) => RequestResolver<A>
   /**
-   * Add a tracing span to the request resolver, which will also add any span
+   * Adds a tracing span to the request resolver, which will also add any span
    * links from the request's.
    *
    * **Example** (Adding a tracing span)