effect 4.0.0-beta.73 → 4.0.0-beta.74

package/src/unstable/http/HttpServerResponse.ts

@@ -95,7 +95,7 @@ export interface HttpServerResponse extends Inspectable.Inspectable, Pipeable, E
 /**
  * Common options accepted by HTTP server response constructors.
  *
- * @category models
+ * @category options
  * @since 4.0.0
  */
 export interface Options {
@@ -118,7 +118,7 @@ export declare namespace Options {
    * Response options for constructors whose body determines its own content type
    * and content length.
    *
-   * @category models
+   * @category options
    * @since 4.0.0
    */
   export interface WithContent extends Omit<Options, "contentType" | "contentLength"> {}
@@ -127,7 +127,7 @@ export declare namespace Options {
    * Response options for constructors that allow overriding the content type while
    * deriving the content length from the body.
    *
-   * @category models
+   * @category options
    * @since 4.0.0
    */
   export interface WithContentType extends Omit<Options, "contentLength"> {}

package/src/unstable/http/Url.ts

@@ -234,21 +234,21 @@ const immutableURLSetter = <P extends keyof URL, A = never>(property: P): {
 /**
  * Updates the hash fragment of the URL.
  *
- * @category Setters
+ * @category setters
  * @since 4.0.0
  */
 export const setHash: {
   /**
    * Updates the hash fragment of the URL.
    *
-   * @category Setters
+   * @category setters
    * @since 4.0.0
    */
   (hash: string): (url: URL) => URL
   /**
    * Updates the hash fragment of the URL.
    *
-   * @category Setters
+   * @category setters
    * @since 4.0.0
    */
   (url: URL, hash: string): URL
@@ -257,21 +257,21 @@ export const setHash: {
 /**
  * Updates the host (domain and port) of the URL.
  *
- * @category Setters
+ * @category setters
  * @since 4.0.0
  */
 export const setHost: {
   /**
    * Updates the host (domain and port) of the URL.
    *
-   * @category Setters
+   * @category setters
    * @since 4.0.0
    */
   (host: string): (url: URL) => URL
   /**
    * Updates the host (domain and port) of the URL.
    *
-   * @category Setters
+   * @category setters
    * @since 4.0.0
    */
   (url: URL, host: string): URL
@@ -280,21 +280,21 @@ export const setHost: {
 /**
  * Updates the domain of the URL without modifying the port.
  *
- * @category Setters
+ * @category setters
  * @since 4.0.0
  */
 export const setHostname: {
   /**
    * Updates the domain of the URL without modifying the port.
    *
-   * @category Setters
+   * @category setters
    * @since 4.0.0
    */
   (hostname: string): (url: URL) => URL
   /**
    * Updates the domain of the URL without modifying the port.
    *
-   * @category Setters
+   * @category setters
    * @since 4.0.0
    */
   (url: URL, hostname: string): URL
@@ -303,21 +303,21 @@ export const setHostname: {
 /**
  * Replaces the entire URL string.
  *
- * @category Setters
+ * @category setters
  * @since 4.0.0
  */
 export const setHref: {
   /**
    * Replaces the entire URL string.
    *
-   * @category Setters
+   * @category setters
    * @since 4.0.0
    */
   (href: string): (url: URL) => URL
   /**
    * Replaces the entire URL string.
    *
-   * @category Setters
+   * @category setters
    * @since 4.0.0
    */
   (url: URL, href: string): URL
@@ -326,21 +326,21 @@ export const setHref: {
 /**
  * Updates the password used for authentication.
  *
- * @category Setters
+ * @category setters
  * @since 4.0.0
  */
 export const setPassword: {
   /**
    * Updates the password used for authentication.
    *
-   * @category Setters
+   * @category setters
    * @since 4.0.0
    */
   (password: string | Redacted.Redacted): (url: URL) => URL
   /**
    * Updates the password used for authentication.
    *
-   * @category Setters
+   * @category setters
    * @since 4.0.0
    */
   (url: URL, password: string | Redacted.Redacted): URL
@@ -354,21 +354,21 @@ export const setPassword: {
 /**
  * Updates the path of the URL.
  *
- * @category Setters
+ * @category setters
  * @since 4.0.0
  */
 export const setPathname: {
   /**
    * Updates the path of the URL.
    *
-   * @category Setters
+   * @category setters
    * @since 4.0.0
    */
   (pathname: string): (url: URL) => URL
   /**
    * Updates the path of the URL.
    *
-   * @category Setters
+   * @category setters
    * @since 4.0.0
    */
   (url: URL, pathname: string): URL
@@ -377,21 +377,21 @@ export const setPathname: {
 /**
  * Updates the port of the URL.
  *
- * @category Setters
+ * @category setters
  * @since 4.0.0
  */
 export const setPort: {
   /**
    * Updates the port of the URL.
    *
-   * @category Setters
+   * @category setters
    * @since 4.0.0
    */
   (port: string | number): (url: URL) => URL
   /**
    * Updates the port of the URL.
    *
-   * @category Setters
+   * @category setters
    * @since 4.0.0
    */
   (url: URL, port: string | number): URL
@@ -400,21 +400,21 @@ export const setPort: {
 /**
  * Updates the protocol (e.g., `http`, `https`).
  *
- * @category Setters
+ * @category setters
  * @since 4.0.0
  */
 export const setProtocol: {
   /**
    * Updates the protocol (e.g., `http`, `https`).
    *
-   * @category Setters
+   * @category setters
    * @since 4.0.0
    */
   (protocol: string): (url: URL) => URL
   /**
    * Updates the protocol (e.g., `http`, `https`).
    *
-   * @category Setters
+   * @category setters
    * @since 4.0.0
    */
   (url: URL, protocol: string): URL
@@ -423,21 +423,21 @@ export const setProtocol: {
 /**
  * Updates the query string of the URL.
  *
- * @category Setters
+ * @category setters
  * @since 4.0.0
  */
 export const setSearch: {
   /**
    * Updates the query string of the URL.
    *
-   * @category Setters
+   * @category setters
    * @since 4.0.0
    */
   (search: string): (url: URL) => URL
   /**
    * Updates the query string of the URL.
    *
-   * @category Setters
+   * @category setters
    * @since 4.0.0
    */
   (url: URL, search: string): URL
@@ -446,21 +446,21 @@ export const setSearch: {
 /**
  * Updates the username used for authentication.
  *
- * @category Setters
+ * @category setters
  * @since 4.0.0
  */
 export const setUsername: {
   /**
    * Updates the username used for authentication.
    *
-   * @category Setters
+   * @category setters
    * @since 4.0.0
    */
   (username: string): (url: URL) => URL
   /**
    * Updates the username used for authentication.
    *
-   * @category Setters
+   * @category setters
    * @since 4.0.0
    */
   (url: URL, username: string): URL
@@ -492,7 +492,7 @@ export const setUsername: {
  * // Output: https://example.com/?key=value
  * ```
  *
- * @category Setters
+ * @category setters
  * @since 4.0.0
  */
 export const setUrlParams: {
@@ -522,7 +522,7 @@ export const setUrlParams: {
    * // Output: https://example.com/?key=value
    * ```
    *
-   * @category Setters
+   * @category setters
    * @since 4.0.0
    */
   (urlParams: UrlParams.UrlParams): (url: URL) => URL
@@ -552,7 +552,7 @@ export const setUrlParams: {
    * // Output: https://example.com/?key=value
    * ```
    *
-   * @category Setters
+   * @category setters
    * @since 4.0.0
    */
   (url: URL, urlParams: UrlParams.UrlParams): URL

package/src/unstable/httpapi/HttpApi.ts

@@ -345,7 +345,7 @@ const extractResponseContent = (
  * Adds additional schemas to components/schemas.
  * The provided schemas must have a `identifier` annotation.
  *
- * @category tags
+ * @category services
  * @since 4.0.0
  */
 export class AdditionalSchemas extends Context.Service<

package/src/unstable/httpapi/HttpApiError.ts

@@ -66,7 +66,7 @@ const serviceUnavailableResponse = HttpServerResponse.empty({ status: 503 })
  * Built-in HTTP API error for a `400 Bad Request` response. When used directly as
  * a server response, it renders as an empty response with status 400.
  *
- * @category Built-in errors
+ * @category errors
  * @since 4.0.0
  */
 export class BadRequest extends Schema.ErrorClass<BadRequest>("effect/HttpApiError/BadRequest")({
@@ -97,7 +97,7 @@ export const BadRequestNoContent = BadRequest.pipe(HttpApiSchema.asNoContent({
  * Built-in HTTP API error for a `401 Unauthorized` response. When used directly as
  * a server response, it renders as an empty response with status 401.
  *
- * @category Built-in errors
+ * @category errors
  * @since 4.0.0
  */
 export class Unauthorized extends Schema.ErrorClass<Unauthorized>("effect/HttpApiError/Unauthorized")({
@@ -127,7 +127,7 @@ export const UnauthorizedNoContent = Unauthorized.pipe(HttpApiSchema.asNoContent
  * Built-in HTTP API error for a `403 Forbidden` response. When used directly as a
  * server response, it renders as an empty response with status 403.
  *
- * @category Built-in errors
+ * @category errors
  * @since 4.0.0
  */
 export class Forbidden extends Schema.ErrorClass<Forbidden>("effect/HttpApiError/Forbidden")({
@@ -157,7 +157,7 @@ export const ForbiddenNoContent = Forbidden.pipe(HttpApiSchema.asNoContent({
  * Built-in HTTP API error for a `404 Not Found` response. When used directly as a
  * server response, it renders as an empty response with status 404.
  *
- * @category Built-in errors
+ * @category errors
  * @since 4.0.0
  */
 export class NotFound extends Schema.ErrorClass<NotFound>("effect/HttpApiError/NotFound")({
@@ -187,7 +187,7 @@ export const NotFoundNoContent = NotFound.pipe(HttpApiSchema.asNoContent({
  * Built-in HTTP API error for a `405 Method Not Allowed` response. When used
  * directly as a server response, it renders as an empty response with status 405.
  *
- * @category Built-in errors
+ * @category errors
  * @since 4.0.0
  */
 export class MethodNotAllowed extends Schema.ErrorClass<MethodNotAllowed>("effect/HttpApiError/MethodNotAllowed")({
@@ -217,7 +217,7 @@ export const MethodNotAllowedNoContent = MethodNotAllowed.pipe(HttpApiSchema.asN
  * Built-in HTTP API error for a `406 Not Acceptable` response. When used directly
  * as a server response, it renders as an empty response with status 406.
  *
- * @category Built-in errors
+ * @category errors
  * @since 4.0.0
  */
 export class NotAcceptable extends Schema.ErrorClass<NotAcceptable>("effect/HttpApiError/NotAcceptable")({
@@ -247,7 +247,7 @@ export const NotAcceptableNoContent = NotAcceptable.pipe(HttpApiSchema.asNoConte
  * Built-in HTTP API error for a `408 Request Timeout` response. When used directly
  * as a server response, it renders as an empty response with status 408.
  *
- * @category Built-in errors
+ * @category errors
  * @since 4.0.0
  */
 export class RequestTimeout extends Schema.ErrorClass<RequestTimeout>("effect/HttpApiError/RequestTimeout")({
@@ -277,7 +277,7 @@ export const RequestTimeoutNoContent = RequestTimeout.pipe(HttpApiSchema.asNoCon
  * Built-in HTTP API error for a `409 Conflict` response. When used directly as a
  * server response, it renders as an empty response with status 409.
  *
- * @category Built-in errors
+ * @category errors
  * @since 4.0.0
  */
 export class Conflict extends Schema.ErrorClass<Conflict>("effect/HttpApiError/Conflict")({
@@ -307,7 +307,7 @@ export const ConflictNoContent = Conflict.pipe(HttpApiSchema.asNoContent({
  * Built-in HTTP API error for a `410 Gone` response. When used directly as a
  * server response, it renders as an empty response with status 410.
  *
- * @category Built-in errors
+ * @category errors
  * @since 4.0.0
  */
 export class Gone extends Schema.ErrorClass<Gone>("effect/HttpApiError/Gone")({
@@ -337,7 +337,7 @@ export const GoneNoContent = Gone.pipe(HttpApiSchema.asNoContent({
  * Built-in HTTP API error for a `500 Internal Server Error` response. When used
  * directly as a server response, it renders as an empty response with status 500.
  *
- * @category Built-in errors
+ * @category errors
  * @since 4.0.0
  */
 export class InternalServerError
@@ -368,7 +368,7 @@ export const InternalServerErrorNoContent = InternalServerError.pipe(HttpApiSche
  * Built-in HTTP API error for a `501 Not Implemented` response. When used directly
  * as a server response, it renders as an empty response with status 501.
  *
- * @category Built-in errors
+ * @category errors
  * @since 4.0.0
  */
 export class NotImplemented extends Schema.ErrorClass<NotImplemented>("effect/HttpApiError/NotImplemented")({
@@ -397,7 +397,7 @@ export const NotImplementedNoContent = NotImplemented.pipe(HttpApiSchema.asNoCon
  * Built-in HTTP API error for a `503 Service Unavailable` response. When used
  * directly as a server response, it renders as an empty response with status 503.
  *
- * @category Built-in errors
+ * @category errors
  * @since 4.0.0
  */
 export class ServiceUnavailable
@@ -445,7 +445,7 @@ export const HttpApiSchemaErrorTypeId: HttpApiSchemaErrorTypeId = "~effect/httpa
  * which component failed and responds as an empty `400 Bad Request` when rendered
  * as a server response.
  *
- * @category Parsing errors
+ * @category errors
  * @since 4.0.0
  */
 export class HttpApiSchemaError extends Data.TaggedClass("HttpApiSchemaError")<{

package/src/unstable/observability/PrometheusMetrics.ts

@@ -72,7 +72,7 @@ export type MetricNameMapper = (name: string) => string
 /**
  * Options for formatting metrics.
  *
- * @category models
+ * @category options
  * @since 4.0.0
  */
 export interface FormatOptions {
@@ -90,7 +90,7 @@ export interface FormatOptions {
 /**
  * Options for exporting Prometheus metrics over HTTP.
  *
- * @category models
+ * @category options
  * @since 4.0.0
  */
 export interface HttpOptions extends FormatOptions {
@@ -128,7 +128,7 @@ export interface HttpOptions extends FormatOptions {
  * })
  * ```
  *
- * @category Formatting
+ * @category formatting
  * @since 4.0.0
  */
 export const format: (options?: FormatOptions | undefined) => Effect.Effect<string> = Effect.fnUntraced(
@@ -146,7 +146,7 @@ export const format: (options?: FormatOptions | undefined) => Effect.Effect<stri
  * Use when you use this low-level function when you already have access to the context. Most
  * users should use `format` instead.
  *
- * @category Formatting
+ * @category formatting
  * @since 4.0.0
  */
 export const formatUnsafe = (

package/src/unstable/persistence/KeyValueStore.ts

@@ -114,7 +114,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 options
  * @since 4.0.0
  */
 export type MakeOptions = Partial<KeyValueStore> & {
@@ -153,7 +153,7 @@ export type MakeOptions = Partial<KeyValueStore> & {
  * Implementation callbacks for adapting a string-only backing store into a
  * `KeyValueStore`.
  *
- * @category models
+ * @category options
  * @since 4.0.0
  */
 export type MakeStringOptions = Partial<Omit<KeyValueStore, "set">> & {
@@ -214,7 +214,7 @@ export class KeyValueStoreError extends Data.TaggedError("KeyValueStoreError")<{
  * Use to access or provide the persistence store used for lightweight durable
  * state.
  *
- * @category tags
+ * @category services
  * @since 4.0.0
  */
 export const KeyValueStore: Context.Service<

package/src/unstable/persistence/Persistable.ts

@@ -235,7 +235,7 @@ const exitSchemaCache = new WeakMap<Persistable<any, any>, Schema.Exit<any, any,
  * Encodes an `Exit` for a persistable request using its success and error
  * schemas.
  *
- * @category Serialization
+ * @category serialization
  * @since 4.0.0
  */
 export const serializeExit = <A extends Schema.Top, E extends Schema.Top>(
@@ -250,7 +250,7 @@ export const serializeExit = <A extends Schema.Top, E extends Schema.Top>(
  * Decodes a persisted value into an `Exit` for a persistable request using its
  * success and error schemas.
  *
- * @category Serialization
+ * @category serialization
  * @since 4.0.0
  */
 export const deserializeExit = <A extends Schema.Top, E extends Schema.Top>(

package/src/unstable/persistence/PersistedQueue.ts

@@ -114,7 +114,7 @@ export interface PersistedQueue<in out A, out R = never> {
 /**
  * Service for constructing named `PersistedQueue` instances from schemas.
  *
- * @category Factory
+ * @category services
  * @since 4.0.0
  */
 export class PersistedQueueFactory extends Context.Service<
@@ -152,7 +152,7 @@ export const make = <S extends Schema.Top>(options: {
  * assigned an id when needed, and acknowledged or retried according to the
  * `take` handler's exit.
  *
- * @category Factory
+ * @category constructors
  * @since 4.0.0
  */
 export const makeFactory = Effect.gen(function*() {
@@ -208,7 +208,7 @@ export const makeFactory = Effect.gen(function*() {
 /**
  * Provides `PersistedQueueFactory` using the current `PersistedQueueStore`.
  *
- * @category Factory
+ * @category layers
  * @since 4.0.0
  */
 export const layer: Layer.Layer<
@@ -305,7 +305,7 @@ export class PersistedQueueStore extends Context.Service<
  * The store is process-local and volatile; failed takes are requeued until the
  * configured maximum attempts is reached.
  *
- * @category Store
+ * @category store
  * @since 4.0.0
  */
 export const layerStoreMemory: Layer.Layer<
@@ -379,7 +379,7 @@ export const layerStoreMemory: Layer.Layer<
  * refreshes locks while items are being processed, and moves exhausted items
  * to a failed queue.
  *
- * @category Store
+ * @category store
  * @since 4.0.0
  */
 export const makeStoreRedis = Effect.fnUntraced(function*(
@@ -740,7 +740,7 @@ end
 /**
  * Provides a Redis-backed `PersistedQueueStore` using `makeStoreRedis`.
  *
- * @category Store
+ * @category store
  * @since 4.0.0
  */
 export const layerStoreRedis: (
@@ -765,7 +765,7 @@ export const layerStoreRedis: (
  * per-worker locks, refreshes active locks while scoped takes are running, and
  * retries or completes rows according to the processing exit.
  *
- * @category Store
+ * @category store
  * @since 4.0.0
  */
 export const makeStoreSql: (
@@ -1195,7 +1195,7 @@ class QueueKey extends Data.Class<{
 /**
  * Provides a SQL-backed `PersistedQueueStore` using `makeStoreSql`.
  *
- * @category Store
+ * @category store
  * @since 4.0.0
  */
 export const layerStoreSql: (

package/src/unstable/persistence/RateLimiter.ts

@@ -79,7 +79,7 @@ export interface RateLimiter {
  * Use to access or provide rate-limit checks backed by fixed-window counters or
  * token-bucket state.
  *
- * @category tags
+ * @category services
  * @since 4.0.0
  */
 export const RateLimiter: Context.Service<RateLimiter, RateLimiter> = Context.Service<RateLimiter>(TypeId)

package/src/unstable/process/ChildProcess.ts

@@ -146,7 +146,7 @@ export type PipeToOption = "stdin" | `fd${number}`
  * )
  * ```
  *
- * @category models
+ * @category options
  * @since 4.0.0
  */
 export interface PipeOptions {
@@ -267,7 +267,7 @@ export type Encoding =
 /**
  * Options that can be used to control how a child process is terminated.
  *
- * @category models
+ * @category options
  * @since 4.0.0
  */
 export interface KillOptions {
@@ -399,7 +399,7 @@ export type AdditionalFdConfig =
 /**
  * Options for command execution.
  *
- * @category models
+ * @category options
  * @since 4.0.0
  */
 export interface CommandOptions extends KillOptions {
@@ -1200,7 +1200,7 @@ const isTemplateString = (u: unknown): u is TemplateStringsArray =>
  * Parses an fd name like "fd3" to its numeric index.
  * Returns undefined if the name is invalid.
  *
- * @category utils
+ * @category converting
  * @since 4.0.0
  */
 export const parseFdName = (name: string): number | undefined => {
@@ -1213,7 +1213,7 @@ export const parseFdName = (name: string): number | undefined => {
 /**
  * Create an fd name from its numeric index.
  *
- * @category utils
+ * @category converting
  * @since 4.0.0
  */
 export const fdName = (fd: number): string => `fd${fd}`

package/src/unstable/reactivity/AsyncResult.ts

@@ -882,7 +882,7 @@ export const all = <const Arg extends Iterable<any> | Record<string, any>>(
 /**
  * Creates a typed builder for rendering an `AsyncResult` by handling waiting, initial, success, error, defect, interrupt, and failure cases.
  *
- * @category Builder
+ * @category constructors
  * @since 4.0.0
  */
 export const builder = <A extends AsyncResult<any, any>>(self: A): Builder<
@@ -896,7 +896,7 @@ export const builder = <A extends AsyncResult<any, any>>(self: A): Builder<
 /**
  * Type marker used by `Builder` to track whether defect failures still need to be handled.
  *
- * @category Builder
+ * @category models
  * @since 4.0.0
  */
 export interface Defect {
@@ -906,7 +906,7 @@ export interface Defect {
 /**
  * Type marker used by `Builder` to track whether interrupt failures still need to be handled.
  *
- * @category Builder
+ * @category models
  * @since 4.0.0
  */
 export interface Interrupt {
@@ -916,7 +916,7 @@ export interface Interrupt {
 /**
  * Fluent renderer for `AsyncResult` values that tracks unhandled cases at the type level and exposes `exhaustive` only after all possible cases are handled.
  *
- * @category Builder
+ * @category models
  * @since 4.0.0
  */
 export type Builder<Out, A, E, I, F> =

package/src/unstable/reactivity/Atom.ts

@@ -2694,7 +2694,7 @@ export const kvs = <S extends Schema.Codec<any, any>, const Mode extends "sync"
  *
  * If you pass a schema, it has to be synchronous and have no context.
  *
- * @category URL search params
+ * @category search params
  * @since 4.0.0
  */
 export const searchParam = <S extends Schema.Codec<any, string> = never>(name: string, options?: {

package/src/unstable/reactivity/AtomRegistry.ts

@@ -204,7 +204,7 @@ export const make = (
  * Use to access or provide the registry that stores atom values,
  * dependencies, subscriptions, and disposal state for a reactive lifetime.
  *
- * @category tags
+ * @category services
  * @since 4.0.0
  */
 export const AtomRegistry = Context.Service<AtomRegistry>(TypeId)