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

package/src/unstable/observability/OtlpMetrics.ts

@@ -51,7 +51,7 @@ import { OtlpSerialization } from "./OtlpSerialization.ts"
  * **Example** (Configuring aggregation temporality)
  *
  * ```ts
- * import * as OtlpMetrics from "effect/unstable/observability/OtlpMetrics"
+ * import { OtlpMetrics } from "effect/unstable/observability"
  *
  * // Use delta temporality for backends that prefer it (e.g., Datadog, Dynatrace)
  * const metricsLayer = OtlpMetrics.layer({
@@ -66,7 +66,7 @@ import { OtlpSerialization } from "./OtlpSerialization.ts"
  * })
  * ```
  *
- * @category Models
+ * @category models
  * @since 4.0.0
  */
 export type AggregationTemporality = "cumulative" | "delta"
@@ -78,7 +78,7 @@ export type AggregationTemporality = "cumulative" | "delta"
  * serializes them with the selected aggregation temporality, and flushes during
  * scope finalization up to `shutdownTimeout`.
  *
- * @category Constructors
+ * @category constructors
  * @since 4.0.0
  */
 export const make: (options: {
@@ -460,7 +460,7 @@ export const make: (options: {
 /**
  * Layer that starts the OTLP metrics exporter created by `make`.
  *
- * @category Layers
+ * @category layers
  * @since 4.0.0
  */
 export const layer = (options: {
@@ -479,6 +479,7 @@ export const layer = (options: {
 /**
  * OTLP metrics payload serialized by `OtlpMetrics`.
  *
+ * @category models
  * @since 4.0.0
  */
 export interface MetricsData {

package/src/unstable/observability/OtlpResource.ts

@@ -28,7 +28,7 @@ import * as Schema from "../../Schema.ts"
 /**
  * OTLP resource metadata attached to exported logs, metrics, and traces.
  *
- * @category Models
+ * @category models
  * @since 4.0.0
  */
 export interface Resource {
@@ -44,7 +44,7 @@ export interface Resource {
  * The resource always includes `service.name`, includes `service.version` when
  * provided, and converts custom attributes into OTLP attribute values.
  *
- * @category Constructors
+ * @category constructors
  * @since 4.0.0
  */
 export const make = (options: {
@@ -84,7 +84,7 @@ export const make = (options: {
  * and `OTEL_SERVICE_VERSION`; missing required configuration is converted to a
  * defect.
  *
- * @category Constructors
+ * @category constructors
  * @since 4.0.0
  */
 export const fromConfig: (
@@ -201,7 +201,7 @@ export const unknownToAttributeValue = (value: unknown): AnyValue => {
 /**
  * An OTLP attribute represented as a string key and typed value.
  *
- * @category Models
+ * @category models
  * @since 4.0.0
  */
 export interface KeyValue {
@@ -214,7 +214,7 @@ export interface KeyValue {
 /**
  * OTLP `AnyValue` payload for scalar, array, key/value-list, or byte values.
  *
- * @category Models
+ * @category models
  * @since 4.0.0
  */
 export interface AnyValue {
@@ -237,7 +237,7 @@ export interface AnyValue {
 /**
  * OTLP array value containing nested `AnyValue` entries.
  *
- * @category Models
+ * @category models
  * @since 4.0.0
  */
 export interface ArrayValue {
@@ -248,7 +248,7 @@ export interface ArrayValue {
 /**
  * OTLP key/value-list value containing nested attributes.
  *
- * @category Models
+ * @category models
  * @since 4.0.0
  */
 export interface KeyValueList {
@@ -259,7 +259,7 @@ export interface KeyValueList {
 /**
  * Low and high 32-bit parts of a 64-bit integer value.
  *
- * @category Models
+ * @category models
  * @since 4.0.0
  */
 export interface LongBits {
@@ -270,7 +270,7 @@ export interface LongBits {
 /**
  * Accepted runtime representations for an OTLP/protobuf fixed 64-bit value.
  *
- * @category Models
+ * @category models
  * @since 4.0.0
  */
 export type Fixed64 = LongBits | string | number

package/src/unstable/observability/OtlpSerialization.ts

@@ -30,7 +30,7 @@ import type { TraceData } from "./OtlpTracer.ts"
  * Service for serializing OTLP traces, metrics, and logs into HTTP request
  * bodies.
  *
- * @category Services
+ * @category services
  * @since 4.0.0
  */
 export class OtlpSerialization extends Context.Service<OtlpSerialization, {
@@ -42,7 +42,7 @@ export class OtlpSerialization extends Context.Service<OtlpSerialization, {
 /**
  * Provides `OtlpSerialization` using OTLP/HTTP JSON bodies.
  *
- * @category Layers
+ * @category layers
  * @since 4.0.0
  */
 export const layerJson = Layer.succeed(OtlpSerialization, {
@@ -55,7 +55,7 @@ export const layerJson = Layer.succeed(OtlpSerialization, {
  * Provides `OtlpSerialization` using protobuf-encoded OTLP bodies with the
  * `application/x-protobuf` content type.
  *
- * @category Layers
+ * @category layers
  * @since 4.0.0
  */
 export const layerProtobuf = Layer.succeed(OtlpSerialization, {

package/src/unstable/observability/OtlpTracer.ts

@@ -49,7 +49,7 @@ import { OtlpSerialization } from "./OtlpSerialization.ts"
  * Spans are batched using the configured interval and batch size, serialized
  * with `OtlpSerialization`, and flushed when the surrounding `Scope` closes.
  *
- * @category Constructors
+ * @category constructors
  * @since 4.0.0
  */
 export const make: (
@@ -129,7 +129,7 @@ export const make: (
 /**
  * Provides `Tracer.Tracer` using the OTLP tracer created by `make`.
  *
- * @category Layers
+ * @category layers
  * @since 4.0.0
  */
 export const layer: (options: {
@@ -306,6 +306,7 @@ const makeOtlpSpan = (self: SpanImpl): OtlpSpan => {
 /**
  * Root OTLP traces payload containing spans grouped by resource.
  *
+ * @category models
  * @since 4.0.0
  */
 export interface TraceData {
@@ -315,6 +316,7 @@ export interface TraceData {
 /**
  * Group of OTLP scope spans associated with a single resource.
  *
+ * @category models
  * @since 4.0.0
  */
 export interface ResourceSpan {
@@ -326,6 +328,7 @@ export interface ResourceSpan {
 /**
  * Group of OTLP spans emitted by a single instrumentation scope.
  *
+ * @category models
  * @since 4.0.0
  */
 export interface ScopeSpan {

package/src/unstable/observability/PrometheusMetrics.ts

@@ -24,7 +24,7 @@
  *
  * ```ts
  * import { Effect, Metric } from "effect"
- * import * as PrometheusMetrics from "effect/unstable/observability/PrometheusMetrics"
+ * import { PrometheusMetrics } from "effect/unstable/observability"
  *
  * const program = Effect.gen(function*() {
  *   // Create and update metrics
@@ -57,14 +57,14 @@ import * as HttpServerResponse from "../http/HttpServerResponse.ts"
  * **Example** (Mapping metric names)
  *
  * ```ts
- * import type * as PrometheusMetrics from "effect/unstable/observability/PrometheusMetrics"
+ * import type { PrometheusMetrics } from "effect/unstable/observability"
  *
  * // Convert camelCase to snake_case
  * const mapper: PrometheusMetrics.MetricNameMapper = (name) =>
  *   name.replace(/([a-z])([A-Z])/g, "$1_$2").toLowerCase()
  * ```
  *
- * @category Models
+ * @category models
  * @since 4.0.0
  */
 export type MetricNameMapper = (name: string) => string
@@ -72,7 +72,7 @@ export type MetricNameMapper = (name: string) => string
 /**
  * Options for formatting metrics.
  *
- * @category Models
+ * @category models
  * @since 4.0.0
  */
 export interface FormatOptions {
@@ -90,7 +90,7 @@ export interface FormatOptions {
 /**
  * Options for exporting Prometheus metrics over HTTP.
  *
- * @category Models
+ * @category models
  * @since 4.0.0
  */
 export interface HttpOptions extends FormatOptions {
@@ -107,7 +107,7 @@ export interface HttpOptions extends FormatOptions {
  *
  * ```ts
  * import { Effect, Metric } from "effect"
- * import * as PrometheusMetrics from "effect/unstable/observability/PrometheusMetrics"
+ * import { PrometheusMetrics } from "effect/unstable/observability"
  *
  * const program = Effect.gen(function*() {
  *   const counter = Metric.counter("api_requests_total", {
@@ -188,7 +188,7 @@ export const formatUnsafe = (
  * **Example** (Serving metrics over HTTP)
  *
  * ```ts
- * import * as PrometheusMetrics from "effect/unstable/observability/PrometheusMetrics"
+ * import { PrometheusMetrics } from "effect/unstable/observability"
  *
  * // Create a layer that adds /metrics endpoint to the router
  * const PrometheusLayer = PrometheusMetrics.layerHttp()

package/src/unstable/observability/index.ts

@@ -5,36 +5,176 @@
 // @barrel: Auto-generated exports. Do not edit manually.
 
 /**
+ * Convenience layers for exporting Effect logs, metrics, and traces over
+ * OTLP/HTTP.
+ *
+ * This module wires the signal-specific OTLP logger, metrics, and tracer
+ * exporters together so an application can install full observability with a
+ * single layer. It is useful for services that report to an OpenTelemetry
+ * Collector, vendor OTLP endpoint, or local collector during development
+ * without configuring each signal independently.
+ *
+ * Pass `baseUrl` as the OTLP/HTTP root URL, such as `http://localhost:4318`;
+ * this module appends `/v1/logs`, `/v1/metrics`, and `/v1/traces` itself.
+ * Use `layerJson` or `layerProtobuf` when you want the serialization layer
+ * provided for you, or use `layer` with a custom `OtlpSerialization`
+ * implementation. Configure authentication with `headers`, provide resource
+ * metadata explicitly or through the standard OTEL resource environment
+ * variables, and tune batch size, export intervals, metric temporality, and
+ * shutdown timeout for the target backend so buffered telemetry is accepted
+ * and flushed before shutdown.
+ *
  * @since 4.0.0
  */
 export * as Otlp from "./Otlp.ts"
 
 /**
+ * Low-level OTLP/HTTP batch exporter used by the observability modules for
+ * logs, metrics, and traces.
+ *
+ * This module owns the scoped transport loop for already-encoded telemetry
+ * payloads: callers provide the OTLP endpoint, request headers, a body encoder,
+ * and batching settings, then push records that should be delivered to a
+ * collector. It is useful when implementing a concrete signal exporter, such
+ * as the OTLP logger or tracer, or when wiring a snapshot-based exporter like
+ * metrics into the same lifecycle and retry behavior.
+ *
+ * The exporter sends HTTP POST requests with the provided `HttpClient`, disables
+ * tracer propagation for its own traffic, retries transient failures, and
+ * honors numeric `retry-after` values on 429 responses. Exports run on
+ * `exportInterval`, flush during scope finalization up to `shutdownTimeout`,
+ * and can also be triggered early when the buffered item count reaches
+ * `maxBatchSize`.
+ *
+ * Use `maxBatchSize: "disabled"` only for pull-style exporters whose `body`
+ * callback builds a fresh payload without relying on drained buffered items,
+ * because pushed data is not cleared in that mode. After an unrecovered export
+ * failure the exporter drops the buffered batch and disables exporting for 60
+ * seconds, so choose intervals, batch sizes, headers, and shutdown timeouts with
+ * collector limits and process shutdown behavior in mind.
+ *
  * @since 4.0.0
  */
 export * as OtlpExporter from "./OtlpExporter.ts"
 
 /**
+ * Exports Effect log records to an OpenTelemetry Protocol (OTLP) logs endpoint.
+ *
+ * Use this module to send Effect log messages, annotations, fiber identifiers,
+ * causes, and active span identifiers to an OpenTelemetry Collector or OTLP
+ * compatible observability backend. `make` is useful for custom logger wiring,
+ * while `layer` installs the logger for an application and can merge it with
+ * any existing loggers.
+ *
+ * Records are buffered by the shared OTLP exporter. `exportInterval`,
+ * `maxBatchSize`, and `shutdownTimeout` control periodic exports, early batch
+ * flushes, and how long scope finalization waits for the final flush. Resource
+ * options are attached to every export and override OpenTelemetry resource
+ * environment variables, so ensure a `service.name` is available through the
+ * options, `OTEL_RESOURCE_ATTRIBUTES`, or `OTEL_SERVICE_NAME`; use `headers`
+ * for collector authentication and `excludeLogSpans` when log span duration
+ * attributes would be too noisy.
+ *
  * @since 4.0.0
  */
 export * as OtlpLogger from "./OtlpLogger.ts"
 
 /**
+ * OTLP/HTTP metrics exporter for Effect's Metric system.
+ *
+ * This module periodically snapshots the metrics registered in the current
+ * Effect context, serializes them as OTLP resource metrics, and posts them to a
+ * metrics endpoint such as an OpenTelemetry Collector or vendor OTLP intake.
+ * It is typically installed with `layer` in long-running services that already
+ * update `Metric` counters, gauges, histograms, frequencies, or summaries and
+ * need those values exported without adding instrumentation-specific plumbing
+ * to the application code.
+ *
+ * Pass the concrete `/v1/metrics` endpoint to `make` or `layer`, or use the
+ * higher-level `Otlp` module when you want `baseUrl` path construction for all
+ * signals. The exporter requires an `HttpClient` and an `OtlpSerialization`
+ * implementation, takes resource metadata from explicit options or standard
+ * OTEL resource environment variables, and uses the resource `service.name` as
+ * the instrumentation scope name. Choose `temporality` for the target backend:
+ * cumulative is the default, while delta derives per-export changes from the
+ * previous snapshot. Gauges always report their current value, and delta
+ * histograms and summaries keep interval counts and sums from previous
+ * snapshots, so tune export intervals and shutdown timeouts with backend
+ * expectations and process shutdown behavior in mind.
+ *
  * @since 4.0.0
  */
 export * as OtlpMetrics from "./OtlpMetrics.ts"
 
 /**
+ * Helpers and data types for describing the OTLP resource attached to exported
+ * logs, metrics, and traces.
+ *
+ * A resource identifies the service that produced telemetry and carries
+ * process- or deployment-level attributes that should be shared across every
+ * signal sent by the Effect OTLP logger, metrics exporter, and tracer. Use this
+ * module when building explicit resource metadata, reading the standard OTEL
+ * resource environment variables, or converting application metadata into OTLP
+ * `KeyValue` / `AnyValue` shapes before serialization.
+ *
+ * `service.name` is required because the signal exporters also use it as the
+ * instrumentation scope name. Explicit resource options take precedence over
+ * `OTEL_RESOURCE_ATTRIBUTES`, `OTEL_SERVICE_NAME`, and
+ * `OTEL_SERVICE_VERSION`; `service.name` and `service.version` are normalized
+ * through the service metadata inputs and re-added as canonical OTLP
+ * attributes rather than left in the custom attribute map. Attribute values are
+ * converted to OTLP scalar or array values where possible, with unsupported
+ * runtime values formatted as strings.
+ *
  * @since 4.0.0
  */
 export * as OtlpResource from "./OtlpResource.ts"
 
 /**
+ * Defines the serialization boundary used by the OTLP observability layers.
+ *
+ * `OtlpSerialization` converts Effect's in-memory OTLP trace, metric, and log
+ * data into `HttpBody` values so exporters can send them to collectors over
+ * OTLP/HTTP. Use this module to choose between the JSON encoding that is useful
+ * for debugging and collector endpoints that explicitly accept OTLP/HTTP JSON,
+ * and the protobuf encoding commonly expected by production OpenTelemetry
+ * collectors.
+ *
+ * The JSON layer writes the telemetry structures directly with
+ * `HttpBody.jsonUnsafe`; the protobuf layer encodes the same structures with
+ * the internal OTLP protobuf encoder and sets the `application/x-protobuf`
+ * content type. Endpoint paths, authentication headers, batching, retries, and
+ * shutdown flushing are handled by the OTLP exporter layers that consume this
+ * service, while this module focuses only on preserving the wire format chosen
+ * for traces, metrics, and logs.
+ *
  * @since 4.0.0
  */
 export * as OtlpSerialization from "./OtlpSerialization.ts"
 
 /**
+ * Exports Effect spans to an OpenTelemetry Protocol (OTLP) traces endpoint.
+ *
+ * This module creates a `Tracer.Tracer` backed by the shared OTLP/HTTP batch
+ * exporter, so Effect spans created with tracing APIs can be delivered to an
+ * OpenTelemetry Collector, vendor OTLP intake, or local development collector.
+ * Use `make` when you need to install the tracer manually, or `layer` when an
+ * application should provide it through the Effect environment.
+ *
+ * Pass a concrete traces endpoint, typically `/v1/traces`, or use the
+ * higher-level `Otlp` module when you want `baseUrl` path construction for all
+ * observability signals. The tracer exports only ended sampled spans, converts
+ * span attributes, events, links, status, parent identifiers, and failure
+ * causes into OTLP trace data, and groups every batch under the configured
+ * resource. Resource options are resolved through `OtlpResource`, so ensure a
+ * stable `service.name` is available through options or standard OTEL resource
+ * environment variables because it is also used as the instrumentation scope
+ * name. Tune `exportInterval`, `maxBatchSize`, and `shutdownTimeout` for the
+ * target backend and process shutdown behavior, provide `headers` for
+ * authentication or routing, choose an `OtlpSerialization` layer accepted by
+ * the endpoint, and use `context` only when a backend needs custom evaluation
+ * around the active span.
+ *
  * @since 4.0.0
  */
 export * as OtlpTracer from "./OtlpTracer.ts"
@@ -42,14 +182,30 @@ export * as OtlpTracer from "./OtlpTracer.ts"
 /**
  * Prometheus metrics exporter for Effect's Metric system.
  *
- * This module provides functionality to export Effect metrics in the Prometheus
- * exposition format, making them scrapeable by Prometheus servers.
+ * This module snapshots the metrics registered in the current Effect context
+ * and renders them in the Prometheus text exposition format. It is intended for
+ * services that already record `Metric` counters, gauges, histograms,
+ * frequencies, or summaries and need a pull-based `/metrics` endpoint, or for
+ * integrations that want the formatted scrape body for a custom HTTP server.
+ *
+ * Use `format` when you need the current runtime's registry rendered as a
+ * string, `formatUnsafe` when you already have the `Context`, and `layerHttp`
+ * when an `HttpRouter` should serve `GET /metrics` directly. Formatting happens
+ * at scrape time; the module does not push metrics, schedule exports, or start
+ * an HTTP server on its own. Make sure the route is installed in the same
+ * application context that records the metrics you want to expose.
+ *
+ * Metric and label names are sanitized for Prometheus, optional prefixes and
+ * name mappers are applied before output, and metric attributes become labels.
+ * Keep attributes low-cardinality, avoid relying on invalid characters being
+ * preserved exactly, and configure Prometheus to scrape the route served by
+ * `layerHttp` with the expected `text/plain; version=0.0.4` response.
  *
  * **Example** (Exporting Prometheus metrics)
  *
  * ```ts
  * import { Effect, Metric } from "effect"
- * import * as PrometheusMetrics from "effect/unstable/observability/PrometheusMetrics"
+ * import { PrometheusMetrics } from "effect/unstable/observability"
  *
  * const program = Effect.gen(function*() {
  *   // Create and update metrics

package/src/unstable/persistence/KeyValueStore.ts

@@ -44,7 +44,7 @@ const TypeId = "~effect/persistence/KeyValueStore" as const
 /**
  * Effectful key/value store service for string and binary values.
  *
- * @category Models
+ * @category models
  * @since 4.0.0
  */
 export interface KeyValueStore {
@@ -112,7 +112,7 @@ export interface KeyValueStore {
  * Primitive operations are required, while helpers such as `has`, `isEmpty`,
  * and `modify` can be supplied to override the defaults.
  *
- * @category Models
+ * @category models
  * @since 4.0.0
  */
 export type MakeOptions = Partial<KeyValueStore> & {
@@ -151,7 +151,7 @@ export type MakeOptions = Partial<KeyValueStore> & {
  * Implementation callbacks for adapting a string-only backing store into a
  * `KeyValueStore`.
  *
- * @category Models
+ * @category models
  * @since 4.0.0
  */
 export type MakeStringOptions = Partial<Omit<KeyValueStore, "set">> & {
@@ -187,7 +187,7 @@ const ErrorTypeId = "~effect/persistence/KeyValueStore/KeyValueStoreError" as co
  * Error raised by key/value store operations, including the failed method,
  * optional key, message, and cause.
  *
- * @category Errors
+ * @category errors
  * @since 4.0.0
  */
 export class KeyValueStoreError extends Data.TaggedError("KeyValueStoreError")<{

package/src/unstable/persistence/Persistable.ts

@@ -43,7 +43,7 @@ export const symbol = "~effect/persistence/Persistable" as const
  * A primary-keyed request value whose success and error results can be
  * serialized for persistence.
  *
- * @category Models
+ * @category models
  * @since 4.0.0
  */
 export interface Persistable<A extends Schema.Top, E extends Schema.Top> extends PrimaryKey.PrimaryKey {
@@ -56,7 +56,7 @@ export interface Persistable<A extends Schema.Top, E extends Schema.Top> extends
 /**
  * Any persistable request regardless of its success and error schemas.
  *
- * @category Models
+ * @category models
  * @since 4.0.0
  */
 export type Any = Persistable<Schema.Top, Schema.Top>
@@ -64,7 +64,7 @@ export type Any = Persistable<Schema.Top, Schema.Top>
 /**
  * Extracts the success schema from a persistable request.
  *
- * @category Models
+ * @category models
  * @since 4.0.0
  */
 export type SuccessSchema<A extends Any> = A["~effect/persistence/Persistable"]["success"]
@@ -72,7 +72,7 @@ export type SuccessSchema<A extends Any> = A["~effect/persistence/Persistable"][
 /**
  * Extracts the success value type from a persistable request.
  *
- * @category Models
+ * @category models
  * @since 4.0.0
  */
 export type Success<A extends Any> = A["~effect/persistence/Persistable"]["success"]["Type"]
@@ -80,7 +80,7 @@ export type Success<A extends Any> = A["~effect/persistence/Persistable"]["succe
 /**
  * Extracts the error schema from a persistable request.
  *
- * @category Models
+ * @category models
  * @since 4.0.0
  */
 export type ErrorSchema<A extends Any> = A["~effect/persistence/Persistable"]["error"]
@@ -88,7 +88,7 @@ export type ErrorSchema<A extends Any> = A["~effect/persistence/Persistable"]["e
 /**
  * Extracts the error value type from a persistable request.
  *
- * @category Models
+ * @category models
  * @since 4.0.0
  */
 export type Error<A extends Any> = A["~effect/persistence/Persistable"]["error"]["Type"]
@@ -97,7 +97,7 @@ export type Error<A extends Any> = A["~effect/persistence/Persistable"]["error"]
  * Services required to decode a persisted success or error value for the
  * request.
  *
- * @category Models
+ * @category models
  * @since 4.0.0
  */
 export type DecodingServices<A extends Any> =
@@ -107,7 +107,7 @@ export type DecodingServices<A extends Any> =
 /**
  * Services required to encode a success or error value for persistence.
  *
- * @category Models
+ * @category models
  * @since 4.0.0
  */
 export type EncodingServices<A extends Any> =
@@ -118,7 +118,7 @@ export type EncodingServices<A extends Any> =
  * All schema services required to encode and decode a persistable request
  * result.
  *
- * @category Models
+ * @category models
  * @since 4.0.0
  */
 export type Services<A extends Any> =
@@ -131,7 +131,7 @@ export type Services<A extends Any> =
  * Computes the time to live for a persisted result from the result `Exit` and
  * request value.
  *
- * @category Models
+ * @category models
  * @since 4.0.0
  */
 export type TimeToLiveFn<K extends Any> = (exit: Exit.Exit<Success<K>, Error<K>>, request: K) => Duration.Input
@@ -142,7 +142,7 @@ export type TimeToLiveFn<K extends Any> = (exit: Exit.Exit<Success<K>, Error<K>>
  * The generated class stores the supplied tag, derives its primary key from
  * the payload, and carries schemas for persisted success and error exits.
  *
- * @category Constructors
+ * @category constructors
  * @since 4.0.0
  */
 export const Class = <

package/src/unstable/persistence/PersistedCache.ts

@@ -33,7 +33,7 @@ const TypeId = "~effect/persistence/PersistedCache" as const
 /**
  * Cache that combines an in-memory `Cache` with a persisted backing store.
  *
- * @category Models
+ * @category models
  * @since 4.0.0
  */
 export interface PersistedCache<K extends Persistable.Any, out R = never> {
@@ -59,7 +59,7 @@ export interface PersistedCache<K extends Persistable.Any, out R = never> {
  * exits with the configured persistent TTL, and also keeps a scoped in-memory
  * cache with its own capacity and TTL.
  *
- * @category Constructors
+ * @category constructors
  * @since 4.0.0
  */
 export const make: <

package/src/unstable/persistence/PersistedQueue.ts

@@ -50,7 +50,7 @@ import * as Redis from "./Redis.ts"
 /**
  * Runtime type identifier for `PersistedQueue` values.
  *
- * @category Type IDs
+ * @category type IDs
  * @since 4.0.0
  */
 export const TypeId: TypeId = "~effect/persistence/PersistedQueue"
@@ -58,7 +58,7 @@ export const TypeId: TypeId = "~effect/persistence/PersistedQueue"
 /**
  * Type-level identifier used to brand `PersistedQueue` values.
  *
- * @category Type IDs
+ * @category type IDs
  * @since 4.0.0
  */
 export type TypeId = "~effect/persistence/PersistedQueue"
@@ -70,7 +70,7 @@ export type TypeId = "~effect/persistence/PersistedQueue"
  * marking it complete on success or retrying it until the maximum attempts is
  * reached.
  *
- * @category Models
+ * @category models
  * @since 4.0.0
  */
 export interface PersistedQueue<in out A, out R = never> {
@@ -213,7 +213,7 @@ export const layer: Layer.Layer<
 /**
  * Runtime type identifier for `PersistedQueueError`.
  *
- * @category Errors
+ * @category errors
  * @since 4.0.0
  */
 export const ErrorTypeId: ErrorTypeId = "~@effect/experimental/PersistedQueue/PersistedQueueError"
@@ -221,7 +221,7 @@ export const ErrorTypeId: ErrorTypeId = "~@effect/experimental/PersistedQueue/Pe
 /**
  * Type-level identifier used to brand `PersistedQueueError` values.
  *
- * @category Errors
+ * @category errors
  * @since 4.0.0
  */
 export type ErrorTypeId = "~@effect/experimental/PersistedQueue/PersistedQueueError"
@@ -229,7 +229,7 @@ export type ErrorTypeId = "~@effect/experimental/PersistedQueue/PersistedQueueEr
 /**
  * Error raised by persisted queue store operations.
  *
- * @category Errors
+ * @category errors
  * @since 4.0.0
  */
 export class PersistedQueueError extends Schema.ErrorClass<PersistedQueueError>(

package/src/unstable/persistence/Persistence.ts

@@ -66,7 +66,7 @@ export class PersistenceError extends Schema.ErrorClass<PersistenceError>(ErrorT
  * Service for creating scoped stores of persisted `Persistable` request
  * results.
  *
- * @category Models
+ * @category models
  * @since 4.0.0
  */
 export class Persistence extends Context.Service<Persistence, {
@@ -1066,6 +1066,7 @@ export const layerSql: Layer.Layer<Persistence, never, SqlClient.SqlClient> = la
  * Returns `null` for no TTL and uses `clock.currentTimeMillisUnsafe`, so it is
  * intended for backing-store internals.
  *
+ * @category converting
  * @since 4.0.0
  */
 export const unsafeTtlToExpires = (clock: Clock.Clock, ttl: Duration.Duration | undefined): number | null =>