effect 4.0.1 → 4.0.3

package/src/Tracer.ts

@@ -7,6 +7,7 @@
  * external span support, trace propagation settings, and the default in-memory
  * span implementation.
  *
+ * @stability stable
  * @since 2.0.0
  */
 import * as Context from "./Context.ts"
@@ -23,6 +24,7 @@ import * as Option from "./Option.ts"
  * `span` to allocate a span from the supplied name, parent, annotations,
  * links, start time, kind, root flag, and sampling decision.
  *
+ * @stability stable
  * @category services
  * @since 2.0.0
  */
@@ -48,6 +50,7 @@ const evaluate = "~effect/Effect/evaluate" satisfies core.evaluate
  * A low-level Effect primitive that can be evaluated by a tracer-specific
  * context for the current fiber.
  *
+ * @stability stable
  * @category models
  * @since 4.0.0
  */
@@ -85,6 +88,7 @@ export interface EffectPrimitive<X> {
  * endedStatus.endTime - endedStatus.startTime // => 500_000_000n
  * ```
  *
+ * @stability stable
  * @category models
  * @since 2.0.0
  */
@@ -119,6 +123,7 @@ export type SpanStatus = {
  * await Effect.runPromise(getSpanIds(externalSpan)) // => ["span-123", "trace-456"]
  * ```
  *
+ * @stability stable
  * @category models
  * @since 2.0.0
  */
@@ -141,6 +146,7 @@ export type AnySpan = Span | ExternalSpan
  * Tracer.ParentSpanKey // => "effect/Tracer/ParentSpan"
  * ```
  *
+ * @stability stable
  * @category constants
  * @since 4.0.0
  */
@@ -165,6 +171,7 @@ export const ParentSpanKey = "effect/Tracer/ParentSpan"
  * await Effect.runPromise(Effect.provideService(program, Tracer.ParentSpan, parent)) // => "span-123"
  * ```
  *
+ * @stability stable
  * @category services
  * @since 2.0.0
  */
@@ -193,6 +200,7 @@ export class ParentSpan extends Context.Service<ParentSpan, AnySpan>()(ParentSpa
  * externalSpan.spanId // => "span-abc-123"
  * ```
  *
+ * @stability stable
  * @category models
  * @since 2.0.0
  */
@@ -240,6 +248,7 @@ export interface ExternalSpan {
  * spans[0]?.status._tag // => "Ended"
  * ```
  *
+ * @stability stable
  * @category options
  * @since 3.1.0
  */
@@ -250,6 +259,7 @@ export interface SpanOptions extends SpanOptionsNoTrace, TraceOptions {}
  * attributes, links, parent or root selection, annotations, span kind,
  * sampling, and the trace level used for filtering.
  *
+ * @stability stable
  * @category options
  * @since 4.0.0
  */
@@ -268,6 +278,7 @@ export interface SpanOptionsNoTrace {
  * Options that control stack trace capture for tracing wrappers.
  * `captureStackTrace` can disable capture or provide a lazy stack string.
  *
+ * @stability stable
  * @category options
  * @since 4.0.0
  */
@@ -304,6 +315,7 @@ export interface TraceOptions {
  * spans[0]?.kind // => "server"
  * ```
  *
+ * @stability stable
  * @category models
  * @since 3.1.0
  */
@@ -366,6 +378,7 @@ export type SpanKind = "internal" | "server" | "client" | "producer" | "consumer
  * events // => [["loaded", 1_250_000_000n, { "cache.hit": true }]]
  * ```
  *
+ * @stability stable
  * @category models
  * @since 2.0.0
  */
@@ -425,6 +438,7 @@ export interface Span {
  * spans[0]?.links[0]?.attributes["link.type"] // => "follows-from"
  * ```
  *
+ * @stability stable
  * @category models
  * @since 2.0.0
  */
@@ -449,6 +463,7 @@ export interface SpanLink {
  *
  * @see {@link Span} for the span values returned by tracer implementations
  *
+ * @stability stable
  * @category constructors
  * @since 2.0.0
  */
@@ -490,6 +505,7 @@ export const make = (options: Tracer): Tracer => options
  * spans.map((span) => Option.getOrUndefined(span.parent)?.spanId) // => ["span-abc-123"]
  * ```
  *
+ * @stability stable
  * @category constructors
  * @since 2.0.0
  */
@@ -534,6 +550,7 @@ export const externalSpan = (
  * await Effect.runPromise(program) // => true
  * ```
  *
+ * @stability stable
  * @category services
  * @since 3.12.0
  */
@@ -557,6 +574,7 @@ export const DisablePropagation = Context.Reference<boolean>(
  *
  * @see {@link MinimumTraceLevel} for the threshold that decides whether spans at that level are sampled
  *
+ * @stability stable
  * @category services
  * @since 4.0.0
  */
@@ -586,6 +604,7 @@ export const CurrentTraceLevel: Context.Reference<LogLevel> = Context.Reference<
  *
  * @see {@link CurrentTraceLevel} for the default span level used when options do not specify one
  *
+ * @stability stable
  * @category services
  * @since 4.0.0
  */
@@ -601,6 +620,7 @@ export const MinimumTraceLevel = Context.Reference<
  * Use when you need the raw context key for active tracer lookup in lower-level
  * tracing code.
  *
+ * @stability stable
  * @category constants
  * @since 4.0.0
  */
@@ -626,6 +646,7 @@ export const TracerKey = "effect/Tracer"
  * await Effect.runPromise(program) // => true
  * ```
  *
+ * @stability stable
  * @category services
  * @since 2.0.0
  */
@@ -644,6 +665,7 @@ export const Tracer: Context.Reference<Tracer> = Context.Reference<Tracer>(Trace
  * that no tracing backend is installed and skip work that only a backend could
  * observe, such as recording span attributes.
  *
+ * @stability stable
  * @category references
  * @since 4.0.0
  */
@@ -666,6 +688,7 @@ export const nativeTracer: Tracer = make({
  *
  * @see {@link Span} for the interface implemented by native spans
  *
+ * @stability stable
  * @category models
  * @since 4.0.0
  */

package/src/Trie.ts

@@ -7,6 +7,7 @@
  * includes exact lookup, prefix lookup, longest-prefix lookup, iteration,
  * mapping, filtering, reducing, and traversal helpers.
  *
+ * @stability stable
  * @since 2.0.0
  */
 import type { Equal } from "./Equal.ts"
@@ -54,6 +55,7 @@ const TypeId = TR.TrieTypeId
  * Trie.size(trie) // => 4
  * ```
  *
+ * @stability stable
  * @category models
  * @since 2.0.0
  */
@@ -77,6 +79,7 @@ export interface Trie<in out Value> extends Iterable<[string, Value]>, Equal, Pi
  * Array.from(trie) // => []
  * ```
  *
+ * @stability stable
  * @category constructors
  * @since 2.0.0
  */
@@ -101,6 +104,7 @@ export const empty: <V = never>() => Trie<V> = TR.empty
  * trie // => Trie.make(["call", 0], ["me", 1], ["mind", 2], ["mid", 3])
  * ```
  *
+ * @stability stable
  * @category constructors
  * @since 2.0.0
  */
@@ -120,6 +124,7 @@ export const fromIterable: <V>(entries: Iterable<readonly [string, V]>) => Trie<
  * trie // => Trie.fromIterable([["ca", 0], ["me", 1]])
  * ```
  *
+ * @stability stable
  * @category constructors
  * @since 2.0.0
  */
@@ -148,6 +153,7 @@ export const make: <Entries extends Array<readonly [string, any]>>(
  * Array.from(trie4) // => [["call", 0], ["me", 1], ["mid", 3], ["mind", 2]]
  * ```
  *
+ * @stability stable
  * @category mutations
  * @since 2.0.0
  */
@@ -173,6 +179,7 @@ export const insert: {
    * Array.from(trie4) // => [["call", 0], ["me", 1], ["mid", 3], ["mind", 2]]
    * ```
    *
+   * @stability stable
    * @category mutations
    * @since 2.0.0
    */
@@ -198,6 +205,7 @@ export const insert: {
    * Array.from(trie4) // => [["call", 0], ["me", 1], ["mid", 3], ["mind", 2]]
    * ```
    *
+   * @stability stable
    * @category mutations
    * @since 2.0.0
    */
@@ -225,6 +233,7 @@ export const insert: {
  * Array.from(Trie.keys(trie)) // => ["abc", "bca", "cab"]
  * ```
  *
+ * @stability stable
  * @category getters
  * @since 2.0.0
  */
@@ -251,6 +260,7 @@ export const keys: <V>(self: Trie<V>) => IterableIterator<string> = TR.keys
  * Array.from(Trie.values(trie)) // => [2, 0, 1]
  * ```
  *
+ * @stability stable
  * @category getters
  * @since 2.0.0
  */
@@ -276,6 +286,7 @@ export const values: <V>(self: Trie<V>) => IterableIterator<V> = TR.values
  * Array.from(Trie.entries(trie)) // => [["call", 0], ["me", 1]]
  * ```
  *
+ * @stability stable
  * @category getters
  * @since 2.0.0
  */
@@ -300,6 +311,7 @@ export const entries: <V>(self: Trie<V>) => IterableIterator<[string, V]> = TR.e
  * Trie.toEntries(trie) // => [["call", 0], ["me", 1]]
  * ```
  *
+ * @stability stable
  * @category getters
  * @since 2.0.0
  */
@@ -324,6 +336,7 @@ export const toEntries = <V>(self: Trie<V>): Array<[string, V]> => Array.from(en
  * Array.from(Trie.keysWithPrefix(trie, "she")) // => ["she", "shells"]
  * ```
  *
+ * @stability stable
  * @category getters
  * @since 2.0.0
  */
@@ -347,6 +360,7 @@ export const keysWithPrefix: {
    * Array.from(Trie.keysWithPrefix(trie, "she")) // => ["she", "shells"]
    * ```
    *
+   * @stability stable
    * @category getters
    * @since 2.0.0
    */
@@ -370,6 +384,7 @@ export const keysWithPrefix: {
    * Array.from(Trie.keysWithPrefix(trie, "she")) // => ["she", "shells"]
    * ```
    *
+   * @stability stable
    * @category getters
    * @since 2.0.0
    */
@@ -395,6 +410,7 @@ export const keysWithPrefix: {
  * Array.from(Trie.valuesWithPrefix(trie, "she")) // => [0, 1]
  * ```
  *
+ * @stability stable
  * @category getters
  * @since 2.0.0
  */
@@ -418,6 +434,7 @@ export const valuesWithPrefix: {
    * Array.from(Trie.valuesWithPrefix(trie, "she")) // => [0, 1]
    * ```
    *
+   * @stability stable
    * @category getters
    * @since 2.0.0
    */
@@ -441,6 +458,7 @@ export const valuesWithPrefix: {
    * Array.from(Trie.valuesWithPrefix(trie, "she")) // => [0, 1]
    * ```
    *
+   * @stability stable
    * @category getters
    * @since 2.0.0
    */
@@ -466,6 +484,7 @@ export const valuesWithPrefix: {
  * Array.from(Trie.entriesWithPrefix(trie, "she")) // => [["she", 0], ["shells", 1]]
  * ```
  *
+ * @stability stable
  * @category getters
  * @since 2.0.0
  */
@@ -489,6 +508,7 @@ export const entriesWithPrefix: {
    * Array.from(Trie.entriesWithPrefix(trie, "she")) // => [["she", 0], ["shells", 1]]
    * ```
    *
+   * @stability stable
    * @category getters
    * @since 2.0.0
    */
@@ -512,6 +532,7 @@ export const entriesWithPrefix: {
    * Array.from(Trie.entriesWithPrefix(trie, "she")) // => [["she", 0], ["shells", 1]]
    * ```
    *
+   * @stability stable
    * @category getters
    * @since 2.0.0
    */
@@ -537,6 +558,7 @@ export const entriesWithPrefix: {
  * Trie.toEntriesWithPrefix(trie, "she") // => [["she", 3], ["shells", 0]]
  * ```
  *
+ * @stability stable
  * @category getters
  * @since 2.0.0
  */
@@ -560,6 +582,7 @@ export const toEntriesWithPrefix: {
    * Trie.toEntriesWithPrefix(trie, "she") // => [["she", 3], ["shells", 0]]
    * ```
    *
+   * @stability stable
    * @category getters
    * @since 2.0.0
    */
@@ -583,6 +606,7 @@ export const toEntriesWithPrefix: {
    * Trie.toEntriesWithPrefix(trie, "she") // => [["she", 3], ["shells", 0]]
    * ```
    *
+   * @stability stable
    * @category getters
    * @since 2.0.0
    */
@@ -608,6 +632,7 @@ export const toEntriesWithPrefix: {
  * Trie.longestPrefixOf(trie, "sells") // => Option.some(["sells", 1])
  * ```
  *
+ * @stability stable
  * @category getters
  * @since 2.0.0
  */
@@ -631,6 +656,7 @@ export const longestPrefixOf: {
    * Trie.longestPrefixOf(trie, "sells") // => Option.some(["sells", 1])
    * ```
    *
+   * @stability stable
    * @category getters
    * @since 2.0.0
    */
@@ -654,6 +680,7 @@ export const longestPrefixOf: {
    * Trie.longestPrefixOf(trie, "sells") // => Option.some(["sells", 1])
    * ```
    *
+   * @stability stable
    * @category getters
    * @since 2.0.0
    */
@@ -676,6 +703,7 @@ export const longestPrefixOf: {
  * Trie.size(trie) // => 2
  * ```
  *
+ * @stability stable
  * @category getters
  * @since 2.0.0
  */
@@ -706,6 +734,7 @@ export const size: <V>(self: Trie<V>) => number = TR.size
  * Trie.get(trie, "mea") // => Option.none()
  * ```
  *
+ * @stability stable
  * @category getters
  * @since 2.0.0
  */
@@ -735,6 +764,7 @@ export const get: {
    * Trie.get(trie, "mea") // => Option.none()
    * ```
    *
+   * @stability stable
    * @category getters
    * @since 2.0.0
    */
@@ -764,6 +794,7 @@ export const get: {
    * Trie.get(trie, "mea") // => Option.none()
    * ```
    *
+   * @stability stable
    * @category getters
    * @since 2.0.0
    */
@@ -795,6 +826,7 @@ export const get: {
  * Trie.has(trie, "mea") // => false
  * ```
  *
+ * @stability stable
  * @category predicates
  * @since 2.0.0
  */
@@ -824,6 +856,7 @@ export const has: {
    * Trie.has(trie, "mea") // => false
    * ```
    *
+   * @stability stable
    * @category predicates
    * @since 2.0.0
    */
@@ -853,6 +886,7 @@ export const has: {
    * Trie.has(trie, "mea") // => false
    * ```
    *
+   * @stability stable
    * @category predicates
    * @since 2.0.0
    */
@@ -874,6 +908,7 @@ export const has: {
  * Trie.isEmpty(trie1) // => false
  * ```
  *
+ * @stability stable
  * @category predicates
  * @since 2.0.0
  */
@@ -908,6 +943,7 @@ export const isEmpty: <V>(self: Trie<V>) => boolean = TR.isEmpty
  * }) // => Result.fail("Expected trie to contain key")
  * ```
  *
+ * @stability stable
  * @category unsafe
  * @since 4.0.0
  */
@@ -941,6 +977,7 @@ export const getUnsafe: {
    * }) // => Result.fail("Expected trie to contain key")
    * ```
    *
+   * @stability stable
    * @category unsafe
    * @since 4.0.0
    */
@@ -974,6 +1011,7 @@ export const getUnsafe: {
    * }) // => Result.fail("Expected trie to contain key")
    * ```
    *
+   * @stability stable
    * @category unsafe
    * @since 4.0.0
    */
@@ -1003,6 +1041,7 @@ export const getUnsafe: {
  * Trie.get(trie2, "call") // => Option.none()
  * ```
  *
+ * @stability stable
  * @category mutations
  * @since 2.0.0
  */
@@ -1030,6 +1069,7 @@ export const remove: {
    * Trie.get(trie2, "call") // => Option.none()
    * ```
    *
+   * @stability stable
    * @category mutations
    * @since 2.0.0
    */
@@ -1057,6 +1097,7 @@ export const remove: {
    * Trie.get(trie2, "call") // => Option.none()
    * ```
    *
+   * @stability stable
    * @category mutations
    * @since 2.0.0
    */
@@ -1082,6 +1123,7 @@ export const remove: {
  * trie.pipe(Trie.reduce("", (acc, _, key) => acc + key)) // => "sellssheshells"
  * ```
  *
+ * @stability stable
  * @category folding
  * @since 2.0.0
  */
@@ -1105,6 +1147,7 @@ export const reduce: {
    * trie.pipe(Trie.reduce("", (acc, _, key) => acc + key)) // => "sellssheshells"
    * ```
    *
+   * @stability stable
    * @category folding
    * @since 2.0.0
    */
@@ -1128,6 +1171,7 @@ export const reduce: {
    * trie.pipe(Trie.reduce("", (acc, _, key) => acc + key)) // => "sellssheshells"
    * ```
    *
+   * @stability stable
    * @category folding
    * @since 2.0.0
    */
@@ -1152,6 +1196,7 @@ export const reduce: {
  * Trie.map(trie, (_, k) => k.length) // => Trie.make(["shells", 6], ["sells", 5], ["she", 3])
  * ```
  *
+ * @stability stable
  * @category folding
  * @since 2.0.0
  */
@@ -1174,6 +1219,7 @@ export const map: {
    * Trie.map(trie, (_, k) => k.length) // => Trie.make(["shells", 6], ["sells", 5], ["she", 3])
    * ```
    *
+   * @stability stable
    * @category folding
    * @since 2.0.0
    */
@@ -1196,6 +1242,7 @@ export const map: {
    * Trie.map(trie, (_, k) => k.length) // => Trie.make(["shells", 6], ["sells", 5], ["she", 3])
    * ```
    *
+   * @stability stable
    * @category folding
    * @since 2.0.0
    */
@@ -1220,6 +1267,7 @@ export const map: {
  * Trie.filter(trie, (_, k) => k.length > 3) // => Trie.make(["shells", 0], ["sells", 1])
  * ```
  *
+ * @stability stable
  * @category filtering
  * @since 2.0.0
  */
@@ -1242,6 +1290,7 @@ export const filter: {
    * Trie.filter(trie, (_, k) => k.length > 3) // => Trie.make(["shells", 0], ["sells", 1])
    * ```
    *
+   * @stability stable
    * @category filtering
    * @since 2.0.0
    */
@@ -1264,6 +1313,7 @@ export const filter: {
    * Trie.filter(trie, (_, k) => k.length > 3) // => Trie.make(["shells", 0], ["sells", 1])
    * ```
    *
+   * @stability stable
    * @category filtering
    * @since 2.0.0
    */
@@ -1286,6 +1336,7 @@ export const filter: {
    * Trie.filter(trie, (_, k) => k.length > 3) // => Trie.make(["shells", 0], ["sells", 1])
    * ```
    *
+   * @stability stable
    * @category filtering
    * @since 2.0.0
    */
@@ -1308,6 +1359,7 @@ export const filter: {
    * Trie.filter(trie, (_, k) => k.length > 3) // => Trie.make(["shells", 0], ["sells", 1])
    * ```
    *
+   * @stability stable
    * @category filtering
    * @since 2.0.0
    */
@@ -1336,6 +1388,7 @@ export const filter: {
  * ) // => Trie.make(["shells", 0], ["sells", 1])
  * ```
  *
+ * @stability stable
  * @category filtering
  * @since 2.0.0
  */
@@ -1362,6 +1415,7 @@ export const filterMap: {
    * ) // => Trie.make(["shells", 0], ["sells", 1])
    * ```
    *
+   * @stability stable
    * @category filtering
    * @since 2.0.0
    */
@@ -1388,6 +1442,7 @@ export const filterMap: {
    * ) // => Trie.make(["shells", 0], ["sells", 1])
    * ```
    *
+   * @stability stable
    * @category filtering
    * @since 2.0.0
    */
@@ -1411,6 +1466,7 @@ export const filterMap: {
  * Trie.compact(trie) // => Trie.make(["shells", 0], ["she", 2])
  * ```
  *
+ * @stability stable
  * @category filtering
  * @since 2.0.0
  */
@@ -1438,6 +1494,7 @@ export const compact: <A>(self: Trie<Option<A>>) => Trie<A> = TR.compact
  * value // => 17
  * ```
  *
+ * @stability stable
  * @category traversing
  * @since 2.0.0
  */
@@ -1464,6 +1521,7 @@ export const forEach: {
    * value // => 17
    * ```
    *
+   * @stability stable
    * @category traversing
    * @since 2.0.0
    */
@@ -1490,6 +1548,7 @@ export const forEach: {
    * value // => 17
    * ```
    *
+   * @stability stable
    * @category traversing
    * @since 2.0.0
    */
@@ -1514,6 +1573,7 @@ export const forEach: {
  * trie.pipe(Trie.modify("me", (v) => v)) // => trie
  * ```
  *
+ * @stability stable
  * @category mutations
  * @since 2.0.0
  */
@@ -1536,6 +1596,7 @@ export const modify: {
    * trie.pipe(Trie.modify("me", (v) => v)) // => trie
    * ```
    *
+   * @stability stable
    * @category mutations
    * @since 2.0.0
    */
@@ -1558,6 +1619,7 @@ export const modify: {
    * trie.pipe(Trie.modify("me", (v) => v)) // => trie
    * ```
    *
+   * @stability stable
    * @category mutations
    * @since 2.0.0
    */
@@ -1581,6 +1643,7 @@ export const modify: {
  * trie.pipe(Trie.removeMany(["she", "sells"])) // => Trie.make(["shells", 0])
  * ```
  *
+ * @stability stable
  * @category mutations
  * @since 2.0.0
  */
@@ -1602,6 +1665,7 @@ export const removeMany: {
    * trie.pipe(Trie.removeMany(["she", "sells"])) // => Trie.make(["shells", 0])
    * ```
    *
+   * @stability stable
    * @category mutations
    * @since 2.0.0
    */
@@ -1623,6 +1687,7 @@ export const removeMany: {
    * trie.pipe(Trie.removeMany(["she", "sells"])) // => Trie.make(["shells", 0])
    * ```
    *
+   * @stability stable
    * @category mutations
    * @since 2.0.0
    */
@@ -1646,6 +1711,7 @@ export const removeMany: {
  * ) // => Trie.make(["shells", 0], ["sells", 1], ["she", 2])
  * ```
  *
+ * @stability stable
  * @category mutations
  * @since 2.0.0
  */
@@ -1667,6 +1733,7 @@ export const insertMany: {
    * ) // => Trie.make(["shells", 0], ["sells", 1], ["she", 2])
    * ```
    *
+   * @stability stable
    * @category mutations
    * @since 2.0.0
    */
@@ -1688,6 +1755,7 @@ export const insertMany: {
    * ) // => Trie.make(["shells", 0], ["sells", 1], ["she", 2])
    * ```
    *
+   * @stability stable
    * @category mutations
    * @since 2.0.0
    */