effect 4.0.0-beta.67 → 4.0.0-beta.69

package/src/Metric.ts

@@ -172,7 +172,7 @@ import type { Contravariant, Covariant } from "./Types.ts"
  * })
  * ```
  *
- * @category Models
+ * @category models
  * @since 2.0.0
  */
 export interface Metric<in Input, out State> extends Pipeable {
@@ -312,7 +312,7 @@ export interface Counter<in Input extends number | bigint> extends Metric<Input,
  * ```
  *
  * @category Counter
- * @since 2.0.0
+ * @since 4.0.0
  */
 export interface CounterState<in Input extends number | bigint> {
   readonly count: Input extends bigint ? bigint : number
@@ -483,7 +483,7 @@ export interface Frequency extends Metric<string, FrequencyState> {}
  * ```
  *
  * @category Metrics
- * @since 2.0.0
+ * @since 4.0.0
  */
 export interface FrequencyState {
   readonly occurrences: ReadonlyMap<string, number>
@@ -613,7 +613,7 @@ export interface Gauge<in Input extends number | bigint> extends Metric<Input, G
  * ```
  *
  * @category Metrics
- * @since 2.0.0
+ * @since 4.0.0
  */
 export interface GaugeState<in Input extends number | bigint> {
   readonly value: Input extends bigint ? bigint : number
@@ -789,7 +789,7 @@ export interface Histogram<Input> extends Metric<Input, HistogramState> {}
  * ```
  *
  * @category Metrics
- * @since 2.0.0
+ * @since 4.0.0
  */
 export interface HistogramState {
   readonly buckets: ReadonlyArray<[number, number]>
@@ -975,7 +975,7 @@ export interface Summary<Input> extends Metric<Input, SummaryState> {}
  * ```
  *
  * @category Metrics
- * @since 2.0.0
+ * @since 4.0.0
  */
 export interface SummaryState {
   readonly quantiles: ReadonlyArray<readonly [number, number | undefined]>
@@ -1028,7 +1028,6 @@ export interface SummaryState {
  * })
  * ```
  *
- * @category models
  * @since 2.0.0
  */
 export declare namespace Metric {
@@ -1109,7 +1108,7 @@ export declare namespace Metric {
    * ```
    *
    * @category types
-   * @since 2.0.0
+   * @since 4.0.0
    */
   export type Type = "Counter" | "Frequency" | "Gauge" | "Histogram" | "Summary"
 
@@ -1185,7 +1184,7 @@ export declare namespace Metric {
    * ```
    *
    * @category types
-   * @since 2.0.0
+   * @since 4.0.0
    */
   export type Attributes = AttributeSet | ReadonlyArray<[string, string]>
 
@@ -1263,7 +1262,7 @@ export declare namespace Metric {
    * ```
    *
    * @category types
-   * @since 2.0.0
+   * @since 4.0.0
    */
   export type AttributeSet = Readonly<Record<string, string>>
 
@@ -1313,7 +1312,7 @@ export declare namespace Metric {
    * ```
    *
    * @category types
-   * @since 2.0.0
+   * @since 4.0.0
    */
   export type Input<A> = A extends Metric<infer _Input, infer _State> ? _Input
     : never
@@ -1373,7 +1372,7 @@ export declare namespace Metric {
    * ```
    *
    * @category types
-   * @since 2.0.0
+   * @since 4.0.0
    */
   export type State<A> = A extends Metric<infer _Input, infer _State> ? _State
     : never
@@ -1419,7 +1418,7 @@ export declare namespace Metric {
    * ```
    *
    * @category interfaces
-   * @since 2.0.0
+   * @since 4.0.0
    */
   export interface Hooks<in Input, out State> {
     readonly get: (context: Context.Context<never>) => State
@@ -1691,7 +1690,7 @@ export declare namespace Metric {
  * })
  * ```
  *
- * @category References
+ * @category references
  * @since 4.0.0
  */
 export const CurrentMetricAttributesKey = "effect/Metric/CurrentMetricAttributes" as const
@@ -1734,7 +1733,7 @@ export const CurrentMetricAttributesKey = "effect/Metric/CurrentMetricAttributes
  * })
  * ```
  *
- * @category References
+ * @category references
  * @since 4.0.0
  */
 export const CurrentMetricAttributes = Context.Reference<Metric.AttributeSet>(CurrentMetricAttributesKey, {
@@ -1750,7 +1749,7 @@ const MetricRegistryKey = "~effect/observability/Metric/MetricRegistryKey"
  * The default registry is an empty `Map`. Metrics register their metadata and
  * hooks lazily in this map when they are read or updated.
  *
- * @category References
+ * @category references
  * @since 4.0.0
  */
 export const MetricRegistry = Context.Reference<Map<string, Metric.Metadata<any, any>>>(
@@ -2145,7 +2144,7 @@ class MetricTransform<in Input, out State, in Input2> extends Metric$<Input2, St
  * console.log(Metric.isMetric(null)) // false
  * ```
  *
- * @category Guards
+ * @category guards
  * @since 4.0.0
  */
 export const isMetric = (u: unknown): u is Metric<unknown, never> =>
@@ -2207,7 +2206,7 @@ export const isMetric = (u: unknown): u is Metric<unknown, never> =>
  * })
  * ```
  *
- * @category Constructors
+ * @category constructors
  * @since 2.0.0
  */
 export const counter: {
@@ -2267,7 +2266,7 @@ export const counter: {
    * })
    * ```
    *
-   * @category Constructors
+   * @category constructors
    * @since 2.0.0
    */
   (
@@ -2335,7 +2334,7 @@ export const counter: {
    * })
    * ```
    *
-   * @category Constructors
+   * @category constructors
    * @since 2.0.0
    */
   (
@@ -2410,7 +2409,7 @@ export const counter: {
  * })
  * ```
  *
- * @category Constructors
+ * @category constructors
  * @since 2.0.0
  */
 export const gauge: {
@@ -2475,7 +2474,7 @@ export const gauge: {
    * })
    * ```
    *
-   * @category Constructors
+   * @category constructors
    * @since 2.0.0
    */
   (
@@ -2547,7 +2546,7 @@ export const gauge: {
    * })
    * ```
    *
-   * @category Constructors
+   * @category constructors
    * @since 2.0.0
    */
   (
@@ -2633,7 +2632,7 @@ export const gauge: {
  * })
  * ```
  *
- * @category Constructors
+ * @category constructors
  * @since 2.0.0
  */
 export const frequency = (name: string, options?: {
@@ -2710,7 +2709,7 @@ export const frequency = (name: string, options?: {
  * })
  * ```
  *
- * @category Constructors
+ * @category constructors
  * @since 2.0.0
  */
 export const histogram = (name: string, options: {
@@ -2797,7 +2796,7 @@ export const histogram = (name: string, options: {
  * })
  * ```
  *
- * @category Constructors
+ * @category constructors
  * @since 2.0.0
  */
 export const summary = (name: string, options: {
@@ -2845,8 +2844,8 @@ export const summary = (name: string, options: {
  * )
  * ```
  *
- * @category Constructors
- * @since 2.0.0
+ * @category constructors
+ * @since 4.0.0
  */
 export const summaryWithTimestamp = (name: string, options: {
   readonly description?: string | undefined
@@ -2896,7 +2895,7 @@ export const summaryWithTimestamp = (name: string, options: {
  * })
  * ```
  *
- * @category Constructors
+ * @category constructors
  * @since 2.0.0
  */
 export const timer = (name: string, options?: {
@@ -2953,7 +2952,7 @@ export const timer = (name: string, options?: {
  * })
  * ```
  *
- * @category Utilities
+ * @category utils
  * @since 2.0.0
  */
 export const value = <Input, State>(
@@ -3002,8 +3001,8 @@ export const value = <Input, State>(
  * })
  * ```
  *
- * @category Utilities
- * @since 2.0.0
+ * @category utils
+ * @since 3.6.5
  */
 export const modify: {
   /**
@@ -3044,8 +3043,8 @@ export const modify: {
    * })
    * ```
    *
-   * @category Utilities
-   * @since 2.0.0
+   * @category utils
+   * @since 3.6.5
    */
   <Input>(input: Input): <State>(self: Metric<Input, State>) => Effect<void>
   /**
@@ -3086,8 +3085,8 @@ export const modify: {
    * })
    * ```
    *
-   * @category Utilities
-   * @since 2.0.0
+   * @category utils
+   * @since 3.6.5
    */
   <Input, State>(self: Metric<Input, State>, input: Input): Effect<void>
 } = dual<
@@ -3129,8 +3128,8 @@ export const modify: {
    * })
    * ```
    *
-   * @category Utilities
-   * @since 2.0.0
+   * @category utils
+   * @since 3.6.5
    */
   <Input>(input: Input) => <State>(self: Metric<Input, State>) => Effect<void>,
   /**
@@ -3171,8 +3170,8 @@ export const modify: {
    * })
    * ```
    *
-   * @category Utilities
-   * @since 2.0.0
+   * @category utils
+   * @since 3.6.5
    */
   <Input, State>(self: Metric<Input, State>, input: Input) => Effect<void>
 >(2, (self, input) =>
@@ -3228,7 +3227,7 @@ export const modify: {
  * })
  * ```
  *
- * @category Utilities
+ * @category utils
  * @since 2.0.0
  */
 export const update: {
@@ -3279,7 +3278,7 @@ export const update: {
    * })
    * ```
    *
-   * @category Utilities
+   * @category utils
    * @since 2.0.0
    */
   <Input>(input: Input): <State>(self: Metric<Input, State>) => Effect<void>
@@ -3330,7 +3329,7 @@ export const update: {
    * })
    * ```
    *
-   * @category Utilities
+   * @category utils
    * @since 2.0.0
    */
   <Input, State>(self: Metric<Input, State>, input: Input): Effect<void>
@@ -3382,7 +3381,7 @@ export const update: {
    * })
    * ```
    *
-   * @category Utilities
+   * @category utils
    * @since 2.0.0
    */
   <Input>(input: Input) => <State>(self: Metric<Input, State>) => Effect<void>,
@@ -3433,7 +3432,7 @@ export const update: {
    * })
    * ```
    *
-   * @category Utilities
+   * @category utils
    * @since 2.0.0
    */
   <Input, State>(self: Metric<Input, State>, input: Input) => Effect<void>
@@ -3479,7 +3478,7 @@ export const update: {
  * })
  * ```
  *
- * @category Mapping
+ * @category mapping
  * @since 2.0.0
  */
 export const mapInput: {
@@ -3519,7 +3518,7 @@ export const mapInput: {
    * })
    * ```
    *
-   * @category Mapping
+   * @category mapping
    * @since 2.0.0
    */
   <Input, Input2 extends Input>(f: (input: Input2, context: Context.Context<never>) => Input): <State>(self: Metric<Input, State>) => Metric<Input2, State>
@@ -3559,7 +3558,7 @@ export const mapInput: {
    * })
    * ```
    *
-   * @category Mapping
+   * @category mapping
    * @since 2.0.0
    */
   <Input, State, Input2>(
@@ -3603,7 +3602,7 @@ export const mapInput: {
    * })
    * ```
    *
-   * @category Mapping
+   * @category mapping
    * @since 2.0.0
    */
   <Input, Input2 extends Input>(f: (input: Input2, context: Context.Context<never>) => Input) => <State>(self: Metric<Input, State>) => Metric<Input2, State>,
@@ -3643,7 +3642,7 @@ export const mapInput: {
    * })
    * ```
    *
-   * @category Mapping
+   * @category mapping
    * @since 2.0.0
    */
   <Input, State, Input2>(
@@ -4255,7 +4254,7 @@ export const snapshot: Effect<ReadonlyArray<Metric.Snapshot>> = InternalEffect.m
  * ```
  *
  * @category Debugging
- * @since 2.0.0
+ * @since 4.0.0
  */
 export const dump: Effect<string> = InternalEffect.flatMap(InternalEffect.context(), (context) => {
   const metrics = snapshotUnsafe(context)
@@ -4352,7 +4351,7 @@ export const dump: Effect<string> = InternalEffect.flatMap(InternalEffect.contex
  * ```
  *
  * @category Snapshotting
- * @since 2.0.0
+ * @since 4.0.0
  */
 export const snapshotUnsafe = (context: Context.Context<never>): ReadonlyArray<Metric.Snapshot> => {
   const registry = Context.get(context, MetricRegistry)
@@ -4487,7 +4486,7 @@ const attributesToString = (attributes: Metric.AttributeSet): string => {
  * ```
  *
  * @category Boundaries
- * @since 2.0.0
+ * @since 4.0.0
  */
 export const boundariesFromIterable = (iterable: Iterable<number>): ReadonlyArray<number> =>
   Arr.append(Arr.filter(new Set(iterable), (n) => n > 0), Number.POSITIVE_INFINITY)
@@ -4537,7 +4536,7 @@ export const boundariesFromIterable = (iterable: Iterable<number>): ReadonlyArra
  * ```
  *
  * @category Boundaries
- * @since 2.0.0
+ * @since 4.0.0
  */
 export const linearBoundaries = (options: {
   readonly start: number
@@ -4596,7 +4595,7 @@ export const linearBoundaries = (options: {
  * ```
  *
  * @category Boundaries
- * @since 2.0.0
+ * @since 4.0.0
  */
 export const exponentialBoundaries = (options: {
   readonly start: number
@@ -4669,9 +4668,8 @@ export const FiberRuntimeMetricsKey: "effect/observability/Metric/FiberRuntimeMe
  * **Example** (Providing a custom fiber metrics service)
  *
  * ```ts
- * import type { Context } from "effect"
  * import { Data, Effect, Layer, Metric } from "effect"
- * import type { Exit } from "effect/Exit"
+ * import type { Context, Exit } from "effect"
  *
  * class MetricsError extends Data.TaggedError("MetricsError")<{
  *   readonly operation: string
@@ -4685,7 +4683,7 @@ export const FiberRuntimeMetricsKey: "effect/observability/Metric/FiberRuntimeMe
  *   },
  *   recordFiberEnd: (
  *     context: Context.Context<never>,
- *     exit: Exit<unknown, unknown>
+ *     exit: Exit.Exit<unknown, unknown>
  *   ) => {
  *     console.log("Fiber completed with exit:", exit)
  *     // Custom logic for tracking fiber completion based on exit status