effect 4.0.0-beta.69 → 4.0.0-beta.70

package/src/SubscriptionRef.ts

@@ -32,6 +32,8 @@ const TypeId = "~effect/SubscriptionRef"
  * A mutable reference whose updates are serialized and published to
  * subscribers.
  *
+ * **When to use**
+ *
  * Use `changes` to observe the current value and subsequent updates as a
  * stream.
  *
@@ -108,6 +110,8 @@ export const make = <A>(value: A): Effect.Effect<SubscriptionRef<A>> =>
  * Creates a stream that emits the current value and all subsequent changes to
  * the `SubscriptionRef`.
  *
+ * **Details**
+ *
  * The stream will first emit the current value, then emit all future changes
  * as they occur.
  *
@@ -146,8 +150,10 @@ export const changes = <A>(self: SubscriptionRef<A>): Stream.Stream<A> => Stream
 /**
  * Unsafely retrieves the current value of the `SubscriptionRef`.
  *
+ * **Gotchas**
+ *
  * This function directly accesses the underlying reference without any
- * synchronization. It should only be used when you're certain there are no
+ * synchronization. It should only be used when you are certain there are no
  * concurrent modifications.
  *
  * **Example** (Reading the current value unsafely)

package/src/SynchronizedRef.ts

@@ -59,6 +59,8 @@ const Proto = {
 /**
  * Creates a `SynchronizedRef` synchronously from an initial value.
  *
+ * **When to use**
+ *
  * This bypasses `Effect` construction; prefer `make` in effectful code.
  *
  * @category constructors

package/src/Tracer.ts

@@ -48,11 +48,9 @@ import type { LogLevel } from "./LogLevel.ts"
 import * as Option from "./Option.ts"
 
 /**
- * A tracing backend used by Effect to create spans.
- *
- * Custom tracers implement `span` to allocate a span from the supplied name,
- * parent, annotations, links, start time, kind, root flag, and sampling
- * decision.
+ * A tracing backend used by Effect to create spans. Custom tracers implement
+ * `span` to allocate a span from the supplied name, parent, annotations,
+ * links, start time, kind, root flag, and sampling decision.
  *
  * @category models
  * @since 2.0.0
@@ -87,10 +85,9 @@ export interface EffectPrimitive<X> {
 }
 
 /**
- * Lifecycle state of a span.
- *
- * `Started` records the start time, while `Ended` records the start time, end
- * time, and exit value with which the span completed.
+ * Lifecycle state of a span, where `Started` records the start time and
+ * `Ended` records the start time, end time, and exit value with which the span
+ * completed.
  *
  * **Example** (Creating span statuses)
  *
@@ -279,7 +276,6 @@ export interface SpanOptionsNoTrace {
 
 /**
  * Options that control stack trace capture for tracing wrappers.
- *
  * `captureStackTrace` can disable capture or provide a lazy stack string.
  *
  * @category models
@@ -319,11 +315,9 @@ export interface TraceOptions {
 export type SpanKind = "internal" | "server" | "client" | "producer" | "consumer"
 
 /**
- * A span created by an Effect tracer.
- *
- * It carries trace identity, parent, annotations, attributes, links, sampling
- * and kind information, lifecycle status, and methods to end the span or add
- * attributes, events, and links.
+ * A span created by an Effect tracer. It carries trace identity, parent,
+ * annotations, attributes, links, sampling and kind information, lifecycle
+ * status, and methods to end the span or add attributes, events, and links.
  *
  * **Example** (Working with spans)
  *
@@ -478,11 +472,9 @@ export const externalSpan = (
 })
 
 /**
- * Reference used to disable trace propagation.
- *
- * When set on the fiber or span annotations, new spans are created as
- * non-propagating no-op spans and disabled spans are skipped when deriving a
- * parent span.
+ * Reference used to disable trace propagation. When set on the fiber or span
+ * annotations, new spans are created as non-propagating no-op spans and
+ * disabled spans are skipped when deriving a parent span.
  *
  * **Example** (Disabling span propagation)
  *
@@ -537,9 +529,8 @@ export const MinimumTraceLevel = Context.Reference<
 export const TracerKey = "effect/Tracer"
 
 /**
- * Context reference for the active tracer service.
- *
- * By default it uses the native tracer, which creates `NativeSpan` instances.
+ * Context reference for the active tracer service. By default it uses the
+ * native tracer, which creates `NativeSpan` instances.
  *
  * **Example** (Accessing the current tracer)
  *
@@ -570,10 +561,9 @@ export const Tracer: Context.Reference<Tracer> = Context.Reference<Tracer>(Trace
 })
 
 /**
- * Default in-memory `Span` implementation used by the native tracer.
- *
- * It generates span and trace identifiers, stores attributes, events, and
- * links, and records `Started` or `Ended` status.
+ * Default in-memory `Span` implementation used by the native tracer. It
+ * generates span and trace identifiers, stores attributes, events, and links,
+ * and records `Started` or `Ended` status.
  *
  * @category native tracer
  * @since 4.0.0

package/src/Trie.ts

@@ -244,6 +244,8 @@ export const insert: {
 /**
  * Returns an `IterableIterator` of the keys within the `Trie`.
  *
+ * **Details**
+ *
  * The keys are returned in alphabetical order, regardless of insertion order.
  *
  * **Example** (Reading keys in alphabetical order)
@@ -270,6 +272,8 @@ export const keys: <V>(self: Trie<V>) => IterableIterator<string> = TR.keys
 /**
  * Returns an `IterableIterator` of the values within the `Trie`.
  *
+ * **Details**
+ *
  * Values are ordered based on their key in alphabetical order, regardless of insertion order.
  *
  * **Example** (Reading values by key order)
@@ -296,6 +300,8 @@ export const values: <V>(self: Trie<V>) => IterableIterator<V> = TR.values
 /**
  * Returns an `IterableIterator` of the entries within the `Trie`.
  *
+ * **Details**
+ *
  * The entries are returned by keys in alphabetical order, regardless of insertion order.
  *
  * **Example** (Reading entries in alphabetical order)
@@ -321,6 +327,8 @@ export const entries: <V>(self: Trie<V>) => IterableIterator<[string, V]> = TR.e
 /**
  * Returns an `Array<[string, V]>` of the entries within the `Trie`.
  *
+ * **Details**
+ *
  * Equivalent to `Array.from(Trie.entries(trie))`.
  *
  * **Example** (Converting entries to an array)
@@ -977,10 +985,12 @@ export const has: {
 export const isEmpty: <V>(self: Trie<V>) => boolean = TR.isEmpty
 
 /**
- * Unsafely lookup the value for the specified key in the `Trie`.
+ * Unsafely looks up the value for the specified key in the `Trie`.
  *
- * `getUnsafe` will throw if the key is not found. Use `get` instead to safely
- * get a value from the `Trie`.
+ * **Gotchas**
+ *
+ * `getUnsafe` throws if the key is not found. Use `get` instead to safely get
+ * a value from the `Trie`.
  *
  * **Example** (Looking up values unsafely)
  *
@@ -1001,10 +1011,12 @@ export const isEmpty: <V>(self: Trie<V>) => boolean = TR.isEmpty
  */
 export const getUnsafe: {
   /**
-   * Unsafely lookup the value for the specified key in the `Trie`.
+   * Unsafely looks up the value for the specified key in the `Trie`.
+   *
+   * **Gotchas**
    *
-   * `getUnsafe` will throw if the key is not found. Use `get` instead to safely
-   * get a value from the `Trie`.
+   * `getUnsafe` throws if the key is not found. Use `get` instead to safely get
+   * a value from the `Trie`.
    *
    * **Example** (Looking up values unsafely)
    *
@@ -1025,10 +1037,12 @@ export const getUnsafe: {
    */
   (key: string): <V>(self: Trie<V>) => V
   /**
-   * Unsafely lookup the value for the specified key in the `Trie`.
+   * Unsafely looks up the value for the specified key in the `Trie`.
+   *
+   * **Gotchas**
    *
-   * `getUnsafe` will throw if the key is not found. Use `get` instead to safely
-   * get a value from the `Trie`.
+   * `getUnsafe` throws if the key is not found. Use `get` instead to safely get
+   * a value from the `Trie`.
    *
    * **Example** (Looking up values unsafely)
    *