effect 3.8.4 → 3.8.5

package/src/MetricKey.ts

@@ -107,6 +107,12 @@ export const isMetricKey: (u: unknown) => u is MetricKey<MetricKeyType.MetricKey
  * @category constructors
  */
 export const counter: {
+  /**
+   * Creates a metric key for a counter, with the specified name.
+   *
+   * @since 2.0.0
+   * @category constructors
+   */
   (
     name: string,
     options?: {
@@ -115,6 +121,12 @@ export const counter: {
       readonly incremental?: boolean | undefined
     }
   ): MetricKey.Counter<number>
+  /**
+   * Creates a metric key for a counter, with the specified name.
+   *
+   * @since 2.0.0
+   * @category constructors
+   */
   (
     name: string,
     options: {
@@ -149,14 +161,32 @@ export const frequency: (
  * @category constructors
  */
 export const gauge: {
-  (name: string, options?: {
-    readonly description?: string | undefined
-    readonly bigint?: false | undefined
-  }): MetricKey.Gauge<number>
-  (name: string, options: {
-    readonly description?: string | undefined
-    readonly bigint: true
-  }): MetricKey.Gauge<bigint>
+  /**
+   * Creates a metric key for a gauge, with the specified name.
+   *
+   * @since 2.0.0
+   * @category constructors
+   */
+  (
+    name: string,
+    options?: {
+      readonly description?: string | undefined
+      readonly bigint?: false | undefined
+    }
+  ): MetricKey.Gauge<number>
+  /**
+   * Creates a metric key for a gauge, with the specified name.
+   *
+   * @since 2.0.0
+   * @category constructors
+   */
+  (
+    name: string,
+    options: {
+      readonly description?: string | undefined
+      readonly bigint: true
+    }
+  ): MetricKey.Gauge<bigint>
 } = internal.gauge
 
 /**
@@ -196,10 +226,22 @@ export const summary: (
  * @category constructors
  */
 export const tagged: {
+  /**
+   * Returns a new `MetricKey` with the specified tag appended.
+   *
+   * @since 2.0.0
+   * @category constructors
+   */
   (
     key: string,
     value: string
   ): <Type extends MetricKeyType.MetricKeyType<any, any>>(self: MetricKey<Type>) => MetricKey<Type>
+  /**
+   * Returns a new `MetricKey` with the specified tag appended.
+   *
+   * @since 2.0.0
+   * @category constructors
+   */
   <Type extends MetricKeyType.MetricKeyType<any, any>>(
     self: MetricKey<Type>,
     key: string,
@@ -214,9 +256,21 @@ export const tagged: {
  * @category constructors
  */
 export const taggedWithLabels: {
+  /**
+   * Returns a new `MetricKey` with the specified tags appended.
+   *
+   * @since 2.0.0
+   * @category constructors
+   */
   (
     extraTags: ReadonlyArray<MetricLabel.MetricLabel>
   ): <Type extends MetricKeyType.MetricKeyType<any, any>>(self: MetricKey<Type>) => MetricKey<Type>
+  /**
+   * Returns a new `MetricKey` with the specified tags appended.
+   *
+   * @since 2.0.0
+   * @category constructors
+   */
   <Type extends MetricKeyType.MetricKeyType<any, any>>(
     self: MetricKey<Type>,
     extraTags: ReadonlyArray<MetricLabel.MetricLabel>

package/src/MetricPolling.ts

@@ -70,11 +70,23 @@ export const collectAll: <R, E, Out>(
  * @category utils
  */
 export const launch: {
-  <A2, R2>(
-    schedule: Schedule.Schedule<A2, unknown, R2>
-  ): <Type, In, R, E, Out>(
+  /**
+   * Returns an effect that will launch the polling metric in a background
+   * fiber, using the specified schedule.
+   *
+   * @since 2.0.0
+   * @category utils
+   */
+  <A2, R2>(schedule: Schedule.Schedule<A2, unknown, R2>): <Type, In, R, E, Out>(
     self: MetricPolling<Type, In, R, E, Out>
   ) => Effect.Effect<Fiber.Fiber<A2, E>, never, R2 | R | Scope.Scope>
+  /**
+   * Returns an effect that will launch the polling metric in a background
+   * fiber, using the specified schedule.
+   *
+   * @since 2.0.0
+   * @category utils
+   */
   <Type, In, R, E, Out, A2, R2>(
     self: MetricPolling<Type, In, R, E, Out>,
     schedule: Schedule.Schedule<A2, unknown, R2>
@@ -108,9 +120,23 @@ export const pollAndUpdate: <Type, In, R, E, Out>(
  * @category constructors
  */
 export const retry: {
+  /**
+   * Returns a new polling metric whose poll function will be retried with the
+   * specified retry policy.
+   *
+   * @since 2.0.0
+   * @category constructors
+   */
   <X, E, R2>(
     policy: Schedule.Schedule<X, E, R2>
   ): <Type, In, R, Out>(self: MetricPolling<Type, In, R, E, Out>) => MetricPolling<Type, In, R2 | R, E, Out>
+  /**
+   * Returns a new polling metric whose poll function will be retried with the
+   * specified retry policy.
+   *
+   * @since 2.0.0
+   * @category constructors
+   */
   <Type, In, R, E, Out, X, R2>(
     self: MetricPolling<Type, In, R, E, Out>,
     policy: Schedule.Schedule<X, E, R2>
@@ -124,9 +150,13 @@ export const retry: {
  * @category utils
  */
 export const zip: {
-  <Type2, In2, R2, E2, Out2>(
-    that: MetricPolling<Type2, In2, R2, E2, Out2>
-  ): <Type, In, R, E, Out>(
+  /**
+   * Zips this polling metric with the specified polling metric.
+   *
+   * @since 2.0.0
+   * @category utils
+   */
+  <Type2, In2, R2, E2, Out2>(that: MetricPolling<Type2, In2, R2, E2, Out2>): <Type, In, R, E, Out>(
     self: MetricPolling<Type, In, R, E, Out>
   ) => MetricPolling<
     readonly [Type, Type2], // readonly because invariant
@@ -135,6 +165,12 @@ export const zip: {
     E2 | E,
     [Out, Out2]
   >
+  /**
+   * Zips this polling metric with the specified polling metric.
+   *
+   * @since 2.0.0
+   * @category utils
+   */
   <Type, In, R, E, Out, Type2, In2, R2, E2, Out2>(
     self: MetricPolling<Type, In, R, E, Out>,
     that: MetricPolling<Type2, In2, R2, E2, Out2>

package/src/MetricState.ts

@@ -172,7 +172,15 @@ export declare namespace MetricState {
  * @category constructors
  */
 export const counter: {
+  /**
+   * @since 2.0.0
+   * @category constructors
+   */
   (count: number): MetricState.Counter<number>
+  /**
+   * @since 2.0.0
+   * @category constructors
+   */
   (count: bigint): MetricState.Counter<bigint>
 } = internal.counter
 
@@ -187,7 +195,15 @@ export const frequency: (occurrences: ReadonlyMap<string, number>) => MetricStat
  * @category constructors
  */
 export const gauge: {
+  /**
+   * @since 2.0.0
+   * @category constructors
+   */
   (count: number): MetricState.Gauge<number>
+  /**
+   * @since 2.0.0
+   * @category constructors
+   */
   (count: bigint): MetricState.Gauge<bigint>
 } = internal.gauge