effect 4.0.0-beta.72 → 4.0.0-beta.74

package/dist/unstable/cluster/HttpRunner.js

@@ -117,7 +117,7 @@ export const layerClientProtocolWebsocketDefault = /*#__PURE__*/layerClientProto
  * The returned effect is produced from `RunnerServer.layerHandlers` and the
  * cluster runner RPC group.
  *
- * @category Http App
+ * @category http app
  * @since 4.0.0
  */
 export const toHttpEffect = /*#__PURE__*/Effect.gen(function* () {
@@ -135,7 +135,7 @@ export const toHttpEffect = /*#__PURE__*/Effect.gen(function* () {
  * The returned effect is produced from `RunnerServer.layerHandlers` and the
  * cluster runner RPC group.
  *
- * @category Http App
+ * @category http app
  * @since 4.0.0
  */
 export const toHttpEffectWebsocket = /*#__PURE__*/Effect.gen(function* () {

package/dist/unstable/cluster/K8sHttpClient.d.ts

@@ -50,7 +50,7 @@ declare const K8sHttpClient_base: Context.ServiceClass<K8sHttpClient, "effect/cl
 /**
  * Service tag for the HTTP client used to call the Kubernetes API.
  *
- * @category Tags
+ * @category services
  * @since 4.0.0
  */
 export declare class K8sHttpClient extends K8sHttpClient_base {

package/dist/unstable/cluster/K8sHttpClient.js

@@ -14,7 +14,7 @@ import * as HttpClientResponse from "../http/HttpClientResponse.js";
 /**
  * Service tag for the HTTP client used to call the Kubernetes API.
  *
- * @category Tags
+ * @category services
  * @since 4.0.0
  */
 export class K8sHttpClient extends /*#__PURE__*/Context.Service()("effect/cluster/K8sHttpClient") {}

package/dist/unstable/cluster/Runners.d.ts

@@ -219,7 +219,7 @@ declare const RpcClientProtocol_base: Context.ServiceClass<RpcClientProtocol, "e
  * Service that creates an RPC client protocol for communicating with a runner at a
  * given address.
  *
- * @category Client
+ * @category client
  * @since 4.0.0
  */
 export declare class RpcClientProtocol extends RpcClientProtocol_base {

package/dist/unstable/cluster/Runners.js

@@ -453,7 +453,7 @@ export const layerRpc = /*#__PURE__*/Layer.effect(Runners, makeRpc).pipe(/*#__PU
  * Service that creates an RPC client protocol for communicating with a runner at a
  * given address.
  *
- * @category Client
+ * @category client
  * @since 4.0.0
  */
 export class RpcClientProtocol extends /*#__PURE__*/Context.Service()("effect/cluster/Runners/RpcClientProtocol") {}

package/dist/unstable/cluster/Sharding.d.ts

@@ -102,7 +102,7 @@ declare const Sharding_base: Context.ServiceClass<Sharding, "effect/cluster/Shar
  * Use to access or provide cluster routing, shard ownership, entity
  * registration, singleton registration, and persisted-work polling.
  *
- * @category tags
+ * @category services
  * @since 4.0.0
  */
 export declare class Sharding extends Sharding_base {

package/dist/unstable/cluster/Sharding.js

@@ -102,7 +102,7 @@ import * as Snowflake from "./Snowflake.js";
  * Use to access or provide cluster routing, shard ownership, entity
  * registration, singleton registration, and persisted-work polling.
  *
- * @category tags
+ * @category services
  * @since 4.0.0
  */
 export class Sharding extends /*#__PURE__*/Context.Service()("effect/cluster/Sharding") {}

package/dist/unstable/cluster/SingletonAddress.d.ts

@@ -41,7 +41,7 @@ declare const SingletonAddress_base: Schema.Class<SingletonAddress, Schema.Struc
 /**
  * Represents the unique address of an singleton within the cluster.
  *
- * @category Address
+ * @category address
  * @since 4.0.0
  */
 export declare class SingletonAddress extends SingletonAddress_base {

package/dist/unstable/cluster/SingletonAddress.js

@@ -37,7 +37,7 @@ const TypeId = "~effect/cluster/SingletonAddress";
 /**
  * Represents the unique address of an singleton within the cluster.
  *
- * @category Address
+ * @category address
  * @since 4.0.0
  */
 export class SingletonAddress extends /*#__PURE__*/Schema.Class(TypeId)({

package/dist/unstable/cluster/Snowflake.d.ts

@@ -153,35 +153,35 @@ export declare const make: (options: {
 /**
  * Extracts the Unix timestamp in milliseconds from a snowflake id.
  *
- * @category Parts
+ * @category parts
  * @since 4.0.0
  */
 export declare const timestamp: (snowflake: Snowflake) => number;
 /**
  * Extracts the timestamp from a snowflake id as a `DateTime.Utc`.
  *
- * @category Parts
+ * @category parts
  * @since 4.0.0
  */
 export declare const dateTime: (snowflake: Snowflake) => DateTime.Utc;
 /**
  * Extracts the machine id component from a snowflake id.
  *
- * @category Parts
+ * @category parts
  * @since 4.0.0
  */
 export declare const machineId: (snowflake: Snowflake) => MachineId;
 /**
  * Extracts the per-machine sequence component from a snowflake id.
  *
- * @category Parts
+ * @category parts
  * @since 4.0.0
  */
 export declare const sequence: (snowflake: Snowflake) => number;
 /**
  * Decomposes a snowflake id into its timestamp, machine id, and sequence parts.
  *
- * @category Parts
+ * @category parts
  * @since 4.0.0
  */
 export declare const toParts: (snowflake: Snowflake) => Snowflake.Parts;

package/dist/unstable/cluster/Snowflake.js

@@ -73,35 +73,35 @@ export const make = options => BigInt(options.timestamp - constEpochMillis) << c
 /**
  * Extracts the Unix timestamp in milliseconds from a snowflake id.
  *
- * @category Parts
+ * @category parts
  * @since 4.0.0
  */
 export const timestamp = snowflake => Number(snowflake >> constBigInt22) + sinceUnixEpoch;
 /**
  * Extracts the timestamp from a snowflake id as a `DateTime.Utc`.
  *
- * @category Parts
+ * @category parts
  * @since 4.0.0
  */
 export const dateTime = snowflake => DateTime.makeUnsafe(timestamp(snowflake));
 /**
  * Extracts the machine id component from a snowflake id.
  *
- * @category Parts
+ * @category parts
  * @since 4.0.0
  */
 export const machineId = snowflake => Number((snowflake >> constBigInt12) % constBigInt1024);
 /**
  * Extracts the per-machine sequence component from a snowflake id.
  *
- * @category Parts
+ * @category parts
  * @since 4.0.0
  */
 export const sequence = snowflake => Number(snowflake % constBigInt4096);
 /**
  * Decomposes a snowflake id into its timestamp, machine id, and sequence parts.
  *
- * @category Parts
+ * @category parts
  * @since 4.0.0
  */
 export const toParts = snowflake => ({

package/dist/unstable/devtools/DevToolsClient.d.ts

@@ -12,7 +12,7 @@ declare const DevToolsClient_base: Context.ServiceClass<DevToolsClient, "effect/
  * Service for sending span and span-event telemetry to the Effect devtools
  * connection.
  *
- * @category tags
+ * @category services
  * @since 4.0.0
  */
 export declare class DevToolsClient extends DevToolsClient_base {

package/dist/unstable/devtools/DevToolsClient.js

@@ -52,7 +52,7 @@ const ResponseSchema = /*#__PURE__*/Schema.toCodecJson(DevToolsSchema.Response);
  * Service for sending span and span-event telemetry to the Effect devtools
  * connection.
  *
- * @category tags
+ * @category services
  * @since 4.0.0
  */
 export class DevToolsClient extends /*#__PURE__*/Context.Service()("effect/devtools/DevToolsClient") {}

package/dist/unstable/eventlog/EventLog.d.ts

@@ -65,7 +65,7 @@ declare const EventLog_base: Context.ServiceClass<EventLog, "effect/eventlog/Eve
  * only when the handler succeeds, and exposes access to the underlying journal
  * entries and destroy operation.
  *
- * @category tags
+ * @category services
  * @since 4.0.0
  */
 export declare class EventLog extends EventLog_base {

package/dist/unstable/eventlog/EventLog.js

@@ -58,7 +58,7 @@ import { StoreId } from "./EventLogMessage.js";
  * only when the handler succeeds, and exposes access to the underlying journal
  * entries and destroy operation.
  *
- * @category tags
+ * @category services
  * @since 4.0.0
  */
 export class EventLog extends /*#__PURE__*/Context.Service()("effect/eventlog/EventLog") {}

package/dist/unstable/eventlog/EventLogEncryption.d.ts

@@ -79,7 +79,7 @@ declare const EventLogEncryption_base: Context.ServiceClass<EventLogEncryption,
  * Use to provide cryptographic operations required by encrypted event-log
  * replication.
  *
- * @category tags
+ * @category services
  * @since 4.0.0
  */
 export declare class EventLogEncryption extends EventLogEncryption_base {

package/dist/unstable/eventlog/EventLogEncryption.js

@@ -67,7 +67,7 @@ const toBufferSource = data => new Uint8Array(toArrayBuffer(data));
  * Use to provide cryptographic operations required by encrypted event-log
  * replication.
  *
- * @category tags
+ * @category services
  * @since 4.0.0
  */
 export class EventLogEncryption extends /*#__PURE__*/Context.Service()("effect/eventlog/EventLogEncryption") {}

package/dist/unstable/eventlog/EventLogRemote.d.ts

@@ -37,7 +37,7 @@ declare const EventLogRemote_base: Context.ServiceClass<EventLogRemote, "effect/
  * It can write local entries to the remote, stream remote changes from a sequence
  * number, and run effects only after the supplied identity has authenticated.
  *
- * @category tags
+ * @category services
  * @since 4.0.0
  */
 export declare class EventLogRemote extends EventLogRemote_base {

package/dist/unstable/eventlog/EventLogRemote.js

@@ -47,7 +47,7 @@ import { makeGetIdentityRootSecretMaterial } from "./internal/identityRootSecret
  * It can write local entries to the remote, stream remote changes from a sequence
  * number, and run effects only after the supplied identity has authenticated.
  *
- * @category tags
+ * @category services
  * @since 4.0.0
  */
 export class EventLogRemote extends /*#__PURE__*/Context.Service()("effect/eventlog/EventLogRemote") {}

package/dist/unstable/eventlog/EventLogServerUnencrypted.d.ts

@@ -28,7 +28,7 @@ declare const EventLogServerUnencrypted_base: Context.ServiceClass<EventLogServe
  * Use to access or provide the server service that handles plaintext
  * event-log writes.
  *
- * @category tags
+ * @category services
  * @since 4.0.0
  */
 export declare class EventLogServerUnencrypted extends EventLogServerUnencrypted_base {
@@ -114,7 +114,7 @@ declare const EventLogServerAuthorization_base: Context.ServiceClass<EventLogSer
  * Use to provide authorization checks for plaintext event-log writes, reads,
  * and identity authentication.
  *
- * @category tags
+ * @category services
  * @since 4.0.0
  */
 export declare class EventLogServerAuthorization extends EventLogServerAuthorization_base {
@@ -138,7 +138,7 @@ declare const StoreMapping_base: Context.ServiceClass<StoreMapping, "effect/even
  * Use to map client-visible store identifiers to server storage identifiers
  * before authorizing or serving unencrypted event-log requests.
  *
- * @category tags
+ * @category services
  * @since 4.0.0
  */
 export declare class StoreMapping extends StoreMapping_base {

package/dist/unstable/eventlog/EventLogServerUnencrypted.js

@@ -66,7 +66,7 @@ import * as EventLogServer from "./EventLogServer.js";
  * Use to access or provide the server service that handles plaintext
  * event-log writes.
  *
- * @category tags
+ * @category services
  * @since 4.0.0
  */
 export class EventLogServerUnencrypted extends /*#__PURE__*/Context.Service()("effect/eventlog/EventLogServerUnencrypted") {}
@@ -199,7 +199,7 @@ export class EventLogServerAuthError extends /*#__PURE__*/Data.TaggedError("Even
  * Use to provide authorization checks for plaintext event-log writes, reads,
  * and identity authentication.
  *
- * @category tags
+ * @category services
  * @since 4.0.0
  */
 export class EventLogServerAuthorization extends /*#__PURE__*/Context.Service()("effect/eventlog/EventLogServerUnencrypted/EventLogServerAuthorization") {}
@@ -212,7 +212,7 @@ export class EventLogServerAuthorization extends /*#__PURE__*/Context.Service()(
  * Use to map client-visible store identifiers to server storage identifiers
  * before authorizing or serving unencrypted event-log requests.
  *
- * @category tags
+ * @category services
  * @since 4.0.0
  */
 export class StoreMapping extends /*#__PURE__*/Context.Service()("effect/eventlog/EventLogServerUnencrypted/StoreMapping") {}

package/dist/unstable/http/Cookies.d.ts

@@ -113,7 +113,7 @@ declare const CookieTypeId = "~effect/http/Cookies/Cookie";
  * HTTP cookie value with its decoded value, encoded value, and optional cookie
  * attributes such as domain, path, expiration, security, and same-site settings.
  *
- * @category cookie
+ * @category cookies
  * @since 4.0.0
  */
 export interface Cookie extends Inspectable.Inspectable {

package/dist/unstable/http/Etag.d.ts

@@ -73,7 +73,7 @@ export interface Strong {
 /**
  * Formats an `Etag` as an HTTP header value, including quotes and the `W/` prefix for weak tags.
  *
- * @category convertions
+ * @category converting
  * @since 4.0.0
  */
 export declare const toString: (self: Etag) => string;

package/dist/unstable/http/Etag.js

@@ -37,7 +37,7 @@ import * as Option from "../../Option.js";
 /**
  * Formats an `Etag` as an HTTP header value, including quotes and the `W/` prefix for weak tags.
  *
- * @category convertions
+ * @category converting
  * @since 4.0.0
  */
 export const toString = self => {

package/dist/unstable/http/FetchHttpClient.d.ts

@@ -41,7 +41,7 @@ import * as HttpClient from "./HttpClient.ts";
  *
  * Defaults to `globalThis.fetch`.
  *
- * @category tags
+ * @category services
  * @since 4.0.0
  */
 export declare const Fetch: Context.Reference<typeof globalThis.fetch>;
@@ -58,7 +58,7 @@ declare const RequestInit_base: Context.ServiceClass<RequestInit, "effect/http/F
  *
  * Request-specific method, headers, body, and abort signal are supplied by the client when a request is executed.
  *
- * @category tags
+ * @category services
  * @since 4.0.0
  */
 export declare class RequestInit extends RequestInit_base {

package/dist/unstable/http/FetchHttpClient.js

@@ -45,7 +45,7 @@ import * as HttpClientResponse from "./HttpClientResponse.js";
  *
  * Defaults to `globalThis.fetch`.
  *
- * @category tags
+ * @category services
  * @since 4.0.0
  */
 export const Fetch = /*#__PURE__*/Context.Reference("effect/http/FetchHttpClient/Fetch", {
@@ -63,7 +63,7 @@ export const Fetch = /*#__PURE__*/Context.Reference("effect/http/FetchHttpClient
  *
  * Request-specific method, headers, body, and abort signal are supplied by the client when a request is executed.
  *
- * @category tags
+ * @category services
  * @since 4.0.0
  */
 export class RequestInit extends /*#__PURE__*/Context.Service()("effect/http/FetchHttpClient/RequestInit") {}

package/dist/unstable/http/HttpClient.d.ts

@@ -122,7 +122,7 @@ export declare namespace HttpClient {
  * Use to provide the HTTP client implementation consumed by the module's
  * request accessor functions.
  *
- * @category tags
+ * @category services
  * @since 4.0.0
  */
 export declare const HttpClient: Context.Service<HttpClient, HttpClient>;

package/dist/unstable/http/HttpClient.js

@@ -40,7 +40,7 @@ export const isHttpClient = u => Predicate.hasProperty(u, TypeId);
  * Use to provide the HTTP client implementation consumed by the module's
  * request accessor functions.
  *
- * @category tags
+ * @category services
  * @since 4.0.0
  */
 export const HttpClient = /*#__PURE__*/Context.Service("effect/HttpClient");

package/dist/unstable/http/HttpClientRequest.d.ts

@@ -82,7 +82,7 @@ export interface HttpClientRequest extends Inspectable.Inspectable, Pipeable {
 /**
  * Options for constructing or modifying an `HttpClientRequest`.
  *
- * @category models
+ * @category options
  * @since 4.0.0
  */
 export interface Options {
@@ -104,7 +104,7 @@ export declare namespace Options {
     /**
      * Request options that omit the method and URL for helpers that already receive those values separately.
      *
-     * @category models
+     * @category options
      * @since 4.0.0
      */
     interface NoUrl extends Omit<Options, "method" | "url"> {

package/dist/unstable/http/HttpMiddleware.d.ts

@@ -90,7 +90,7 @@ export declare const xForwardedHeaders: <E, R>(httpApp: Effect.Effect<Response.H
 /**
  * Middleware that parses the current request URL's search parameters and provides them as `ParsedSearchParams`.
  *
- * @category Search params
+ * @category search params
  * @since 4.0.0
  */
 export declare const searchParamsParser: <E, R>(httpApp: Effect.Effect<HttpServerResponse, E, R>) => Effect.Effect<Response.HttpServerResponse, E, HttpServerRequest | Exclude<R, Request.ParsedSearchParams>>;

package/dist/unstable/http/HttpMiddleware.js

@@ -194,7 +194,7 @@ export const xForwardedHeaders = /*#__PURE__*/make(httpApp => Effect.updateServi
 /**
  * Middleware that parses the current request URL's search parameters and provides them as `ParsedSearchParams`.
  *
- * @category Search params
+ * @category search params
  * @since 4.0.0
  */
 export const searchParamsParser = httpApp => Effect.withFiber(fiber => {

package/dist/unstable/http/HttpPlatform.d.ts

@@ -46,7 +46,7 @@ declare const HttpPlatform_base: Context.ServiceClass<HttpPlatform, "effect/http
 /**
  * Service for platform-specific HTTP response helpers, including file-backed server responses.
  *
- * @category tags
+ * @category services
  * @since 4.0.0
  */
 export declare class HttpPlatform extends HttpPlatform_base {

package/dist/unstable/http/HttpPlatform.js

@@ -35,7 +35,7 @@ import * as Response from "./HttpServerResponse.js";
 /**
  * Service for platform-specific HTTP response helpers, including file-backed server responses.
  *
- * @category tags
+ * @category services
  * @since 4.0.0
  */
 export class HttpPlatform extends /*#__PURE__*/Context.Service()("effect/http/HttpPlatform") {}

package/dist/unstable/http/HttpRouter.d.ts

@@ -86,7 +86,7 @@ declare const RouteContext_base: Context.ServiceClass<RouteContext, "effect/http
  * It provides the route definition and the path parameters captured by the route
  * matcher.
  *
- * @category route context
+ * @category services
  * @since 4.0.0
  */
 export declare class RouteContext extends RouteContext_base {
@@ -94,7 +94,7 @@ export declare class RouteContext extends RouteContext_base {
 /**
  * Effect that returns the path parameters captured for the current matched route.
  *
- * @category RouteContext
+ * @category getters
  * @since 4.0.0
  */
 export declare const params: Effect.Effect<ReadonlyRecord<string, string | undefined>, never, RouteContext>;
@@ -654,7 +654,7 @@ export declare const provideRequest: <A2, E2, R2>(layer: Layer.Layer<A2, E2, R2>
 /**
  * Runs the provided application layer as an HTTP server.
  *
- * @category Server
+ * @category server
  * @since 4.0.0
  */
 export declare const serve: <A, E, R, HE, HR = Request.Only<"Requires", R> | Request.Only<"GlobalRequires", R>>(appLayer: Layer.Layer<A, E, R>, options?: {
@@ -683,7 +683,7 @@ export declare const serve: <A, E, R, HE, HR = Request.Only<"Requires", R> | Req
  * Web `Response` values and a `dispose` function for releasing the layer
  * resources.
  *
- * @category Server
+ * @category server
  * @since 4.0.0
  */
 export declare const toWebHandler: <A, E, R extends HttpRouter | Request<"Requires", any> | Request<"GlobalRequires", any> | Request<"Error", any> | Request<"GlobalError", any>, HE, HR = Exclude<Request.Only<"Requires", R> | Request.Only<"GlobalRequires", R>, A>>(appLayer: Layer.Layer<A, E, R>, options?: {

package/dist/unstable/http/HttpRouter.js

@@ -204,14 +204,14 @@ export const RouterConfig = /*#__PURE__*/Context.Reference("effect/http/HttpRout
  * It provides the route definition and the path parameters captured by the route
  * matcher.
  *
- * @category route context
+ * @category services
  * @since 4.0.0
  */
 export class RouteContext extends /*#__PURE__*/Context.Service()("effect/http/HttpRouter/RouteContext") {}
 /**
  * Effect that returns the path parameters captured for the current matched route.
  *
- * @category RouteContext
+ * @category getters
  * @since 4.0.0
  */
 export const params = /*#__PURE__*/Effect.map(RouteContext, _ => _.params);
@@ -644,7 +644,7 @@ export const provideRequest = layer => self => Layer.provide(self, middleware()(
 /**
  * Runs the provided application layer as an HTTP server.
  *
- * @category Server
+ * @category server
  * @since 4.0.0
  */
 export const serve = (appLayer, options) => {
@@ -669,7 +669,7 @@ export const serve = (appLayer, options) => {
  * Web `Response` values and a `dispose` function for releasing the layer
  * resources.
  *
- * @category Server
+ * @category server
  * @since 4.0.0
  */
 export const toWebHandler = (appLayer, options) => {

package/dist/unstable/http/HttpServerResponse.d.ts

@@ -84,7 +84,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 {
@@ -106,7 +106,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
      */
     interface WithContent extends Omit<Options, "contentType" | "contentLength"> {
@@ -115,7 +115,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
      */
     interface WithContentType extends Omit<Options, "contentLength"> {