effect 3.13.7 → 3.13.9

package/src/Metric.ts

@@ -176,8 +176,8 @@ export const mapInput: {
  * Represents a Counter metric that tracks cumulative numerical values over time.
  * Counters can be incremented and decremented and provide a running total of changes.
  *
- * @param name - The name of the counter metric.
- * @param options - An optional configuration for the counter:
+ * **Options**
+ *
  * - description - A description of the counter.
  * - bigint - Indicates if the counter uses 'bigint' data type.
  * - incremental - Set to 'true' for a counter that only increases. With this configuration, Effect ensures that non-incremental updates have no impact on the counter, making it exclusively suitable for counting upwards.
@@ -204,8 +204,8 @@ export const counter: {
    * Represents a Counter metric that tracks cumulative numerical values over time.
    * Counters can be incremented and decremented and provide a running total of changes.
    *
-   * @param name - The name of the counter metric.
-   * @param options - An optional configuration for the counter:
+   * **Options**
+   *
    * - description - A description of the counter.
    * - bigint - Indicates if the counter uses 'bigint' data type.
    * - incremental - Set to 'true' for a counter that only increases. With this configuration, Effect ensures that non-incremental updates have no impact on the counter, making it exclusively suitable for counting upwards.
@@ -239,8 +239,8 @@ export const counter: {
    * Represents a Counter metric that tracks cumulative numerical values over time.
    * Counters can be incremented and decremented and provide a running total of changes.
    *
-   * @param name - The name of the counter metric.
-   * @param options - An optional configuration for the counter:
+   * **Options**
+   *
    * - description - A description of the counter.
    * - bigint - Indicates if the counter uses 'bigint' data type.
    * - incremental - Set to 'true' for a counter that only increases. With this configuration, Effect ensures that non-incremental updates have no impact on the counter, making it exclusively suitable for counting upwards.
@@ -276,9 +276,6 @@ export const counter: {
  * Creates a Frequency metric to count occurrences of events.
  * Frequency metrics are used to count the number of times specific events or incidents occur.
  *
- * @param name - The name of the Frequency metric.
- * @param description - An optional description of the Frequency metric.
- *
  * @example
  * ```ts
  * import { Metric } from "effect"
@@ -340,8 +337,8 @@ export const fromMetricKey: <Type extends MetricKeyType.MetricKeyType<any, any>>
  * Represents a Gauge metric that tracks and reports a single numerical value at a specific moment.
  * Gauges are suitable for metrics that represent instantaneous values, such as memory usage or CPU load.
  *
- * @param name - The name of the gauge metric.
- * @param options - An optional configuration for the gauge:
+ * **Options**
+ *
  * - description - A description of the gauge metric.
  * - bigint - Indicates if the counter uses 'bigint' data type.
  *
@@ -367,8 +364,8 @@ export const gauge: {
    * Represents a Gauge metric that tracks and reports a single numerical value at a specific moment.
    * Gauges are suitable for metrics that represent instantaneous values, such as memory usage or CPU load.
    *
-   * @param name - The name of the gauge metric.
-   * @param options - An optional configuration for the gauge:
+   * **Options**
+   *
    * - description - A description of the gauge metric.
    * - bigint - Indicates if the counter uses 'bigint' data type.
    *
@@ -400,8 +397,8 @@ export const gauge: {
    * Represents a Gauge metric that tracks and reports a single numerical value at a specific moment.
    * Gauges are suitable for metrics that represent instantaneous values, such as memory usage or CPU load.
    *
-   * @param name - The name of the gauge metric.
-   * @param options - An optional configuration for the gauge:
+   * **Options**
+   *
    * - description - A description of the gauge metric.
    * - bigint - Indicates if the counter uses 'bigint' data type.
    *
@@ -435,10 +432,6 @@ export const gauge: {
  * Represents a Histogram metric that records observations in specified value boundaries.
  * Histogram metrics are useful for measuring the distribution of values within a range.
  *
- * @param name - The name of the histogram metric.
- * @param boundaries - The boundaries for defining the histogram's value ranges.
- * @param description - A description of the histogram metric.
- *
  * @example
  * ```ts
  * import { Metric, MetricBoundaries } from "effect"
@@ -623,7 +616,8 @@ export const sync: <Out>(evaluate: LazyArg<Out>) => Metric<void, unknown, Out> =
  * Creates a Summary metric that records observations and calculates quantiles.
  * Summary metrics provide statistical information about a set of values, including quantiles.
  *
- * @param options - An object with configuration options for the Summary metric:
+ * **Options**
+ *
  * - name - The name of the Summary metric.
  * - maxAge - The maximum age of observations to retain.
  * - maxSize - The maximum number of observations to keep.

package/src/Micro.ts

@@ -1048,7 +1048,7 @@ export {
    * import { Micro } from "effect"
    *
    * Micro.try({
-   *   try: () => throw new Error("boom"),
+   *   try: () => { throw new Error("boom") },
    *   catch: (cause) => new Error("caught", { cause })
    * })
    * ```