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

package/dist/unstable/persistence/RateLimiter.js

@@ -49,7 +49,7 @@ export const TypeId = "~effect/persistence/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 = /*#__PURE__*/Context.Service(TypeId);

package/dist/unstable/process/ChildProcess.d.ts

@@ -77,7 +77,7 @@ export type PipeToOption = "stdin" | `fd${number}`;
  * )
  * ```
  *
- * @category models
+ * @category options
  * @since 4.0.0
  */
 export interface PipeOptions {
@@ -133,7 +133,7 @@ export type Encoding = "ascii" | "utf8" | "utf-8" | "utf16le" | "utf-16le" | "uc
 /**
  * Options that can be used to control how a child process is terminated.
  *
- * @category models
+ * @category options
  * @since 4.0.0
  */
 export interface KillOptions {
@@ -258,7 +258,7 @@ export type AdditionalFdConfig = {
 /**
  * Options for command execution.
  *
- * @category models
+ * @category options
  * @since 4.0.0
  */
 export interface CommandOptions extends KillOptions {
@@ -893,14 +893,14 @@ export declare const setEnv: {
  * 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 declare const parseFdName: (name: string) => number | undefined;
 /**
  * Create an fd name from its numeric index.
  *
- * @category utils
+ * @category converting
  * @since 4.0.0
  */
 export declare const fdName: (fd: number) => string;

package/dist/unstable/process/ChildProcess.js

@@ -323,7 +323,7 @@ const isTemplateString = u => Array.isArray(u) && "raw" in u && Array.isArray(u.
  * 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 => {
@@ -335,7 +335,7 @@ export const parseFdName = name => {
 /**
  * Create an fd name from its numeric index.
  *
- * @category utils
+ * @category converting
  * @since 4.0.0
  */
 export const fdName = fd => `fd${fd}`;

package/dist/unstable/reactivity/AsyncResult.d.ts

@@ -529,14 +529,14 @@ export declare 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 declare const builder: <A extends AsyncResult<any, any>>(self: A) => Builder<never, A extends Success<infer _A, infer _E> ? _A : never, A extends Failure<infer _A, infer _E_1> ? _E_1 : never, A extends Initial<infer _A, infer _E_2> ? true : never, A extends Failure<infer _A, infer _E_3> ? Defect | Interrupt : never>;
 /**
  * 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 {
@@ -545,7 +545,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 {
@@ -554,7 +554,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> = Pipeable & {

package/dist/unstable/reactivity/AsyncResult.js

@@ -490,7 +490,7 @@ export const all = results => {
 /**
  * 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 = self => new BuilderImpl(self);

package/dist/unstable/reactivity/Atom.d.ts

@@ -1193,7 +1193,7 @@ export declare const kvs: <S extends Schema.Codec<any, any>, const Mode extends
  *
  * 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 declare const searchParam: <S extends Schema.Codec<any, string> = never>(name: string, options?: {

package/dist/unstable/reactivity/Atom.js

@@ -1238,7 +1238,7 @@ export const kvs = options => {
  *
  * 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 = (name, options) => {

package/dist/unstable/reactivity/AtomRegistry.d.ts

@@ -182,7 +182,7 @@ export declare const make: (options?: {
  * 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 declare const AtomRegistry: Context.Service<AtomRegistry, AtomRegistry>;

package/dist/unstable/reactivity/AtomRegistry.js

@@ -124,7 +124,7 @@ export const make = options => new RegistryImpl(options?.initialValues, options?
  * 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 = /*#__PURE__*/Context.Service(TypeId);

package/dist/unstable/reactivity/Reactivity.d.ts

@@ -70,7 +70,7 @@ declare const Reactivity_base: Context.ServiceClass<Reactivity, "effect/reactivi
  * mutations so successful effects invalidate keys, and turn query effects into
  * queues or streams that rerun when keys are invalidated.
  *
- * @category tags
+ * @category services
  * @since 4.0.0
  */
 export declare class Reactivity extends Reactivity_base {

package/dist/unstable/reactivity/Reactivity.js

@@ -63,7 +63,7 @@ import * as Stream from "../../Stream.js";
  * mutations so successful effects invalidate keys, and turn query effects into
  * queues or streams that rerun when keys are invalidated.
  *
- * @category tags
+ * @category services
  * @since 4.0.0
  */
 export class Reactivity extends /*#__PURE__*/Context.Service()("effect/reactivity/Reactivity") {}

package/dist/unstable/rpc/Rpc.d.ts

@@ -546,7 +546,7 @@ export declare const make: <const Tag extends string, Payload extends Schema.Top
  * })
  * ```
  *
- * @category Custom constructors
+ * @category constructors
  * @since 4.0.0
  */
 export declare const custom: <Def extends Custom>(f: (options: Custom.OutDefault) => (Def & Custom.OutDefault)["out"]) => <const Tag extends string, Payload extends Schema.Top | Schema.Struct.Fields = Schema.Void, Success extends Schema.Top = Schema.Void, Error extends Schema.Top = Schema.Never, const Stream extends boolean = false, Out extends Custom.OutDefault = Custom.Kind<Def, Success, Error>>(tag: Tag, options?: {
@@ -565,7 +565,7 @@ export declare const custom: <Def extends Custom>(f: (options: Custom.OutDefault
  * A custom constructor receives the original success, error, and defect schemas
  * and returns transformed output schemas through `out`.
  *
- * @category Custom constructors
+ * @category constructors
  * @since 4.0.0
  */
 export interface Custom {
@@ -583,7 +583,7 @@ export declare namespace Custom {
     /**
      * The transformed schemas produced by a custom RPC constructor.
      *
-     * @category Custom constructors
+     * @category constructors
      * @since 4.0.0
      */
     interface Out<Success extends Schema.Top, Error extends Schema.Top> {
@@ -595,7 +595,7 @@ export declare namespace Custom {
      * The default custom-constructor output shape for arbitrary success and error
      * schemas.
      *
-     * @category Custom constructors
+     * @category constructors
      * @since 4.0.0
      */
     type OutDefault = Out<Schema.Top, Schema.Top>;
@@ -603,7 +603,7 @@ export declare namespace Custom {
      * Applies a custom constructor definition to concrete success and error
      * schemas and returns its transformed output schema type.
      *
-     * @category Custom constructors
+     * @category constructors
      * @since 4.0.0
      */
     type Kind<Def extends Custom, Success extends Schema.Top, Error extends Schema.Top> = (Def & {

package/dist/unstable/rpc/Rpc.js

@@ -211,7 +211,7 @@ export const make = (tag, options) => {
  * })
  * ```
  *
- * @category Custom constructors
+ * @category constructors
  * @since 4.0.0
  */
 export const custom = f => (tag, options) => {

package/dist/unstable/rpc/RpcMiddleware.d.ts

@@ -256,7 +256,7 @@ export interface AnyServiceWithProps extends Context.Key<any, RpcMiddleware<any,
  * requirements, provided services, error schema, and client-side requirement
  * metadata.
  *
- * @category tags
+ * @category constructors
  * @since 4.0.0
  */
 export declare const Service: <Self, Config extends {

package/dist/unstable/rpc/RpcMiddleware.js

@@ -54,7 +54,7 @@ export const TypeId = "~effect/rpc/RpcMiddleware";
  * requirements, provided services, error schema, and client-side requirement
  * metadata.
  *
- * @category tags
+ * @category constructors
  * @since 4.0.0
  */
 export const Service = () => (id, options) => {

package/dist/unstable/rpc/RpcSchema.d.ts

@@ -43,7 +43,7 @@ declare const StreamSchemaTypeId = "~effect/rpc/RpcSchema/StreamSchema";
  * Returns `true` when a schema is an RPC stream schema created by
  * `RpcSchema.Stream`.
  *
- * @category Stream
+ * @category streams
  * @since 4.0.0
  */
 export declare function isStreamSchema(schema: Schema.Top): schema is Stream<Schema.Top, Schema.Top>;
@@ -51,7 +51,7 @@ export declare function isStreamSchema(schema: Schema.Top): schema is Stream<Sch
  * A schema marker for RPC streaming responses, storing the success element
  * schema and stream error schema used for encoding and decoding stream chunks.
  *
- * @category Stream
+ * @category streams
  * @since 4.0.0
  */
 export interface Stream<A extends Schema.Top, E extends Schema.Top> extends Schema.Bottom<Stream_.Stream<A["Type"], E["Type"]>, Stream_.Stream<A["Encoded"], E["Encoded"]>, A["DecodingServices"] | E["DecodingServices"], A["EncodingServices"] | E["EncodingServices"], AST.Declaration, Stream<A, E>> {
@@ -64,7 +64,7 @@ export interface Stream<A extends Schema.Top, E extends Schema.Top> extends Sche
  * Creates an RPC stream schema from a stream element success schema and stream
  * error schema.
  *
- * @category Stream
+ * @category streams
  * @since 4.0.0
  */
 export declare function Stream<A extends Schema.Top, E extends Schema.Top>(success: A, error: E): Stream<A, E>;

package/dist/unstable/rpc/RpcSchema.js

@@ -45,7 +45,7 @@ const StreamSchemaTypeId = "~effect/rpc/RpcSchema/StreamSchema";
  * Returns `true` when a schema is an RPC stream schema created by
  * `RpcSchema.Stream`.
  *
- * @category Stream
+ * @category streams
  * @since 4.0.0
  */
 export function isStreamSchema(schema) {
@@ -63,7 +63,7 @@ const schema = /*#__PURE__*/Schema.declare(Stream_.isStream);
  * Creates an RPC stream schema from a stream element success schema and stream
  * error schema.
  *
- * @category Stream
+ * @category streams
  * @since 4.0.0
  */
 export function Stream(success, error) {

package/dist/unstable/schema/Model.d.ts

@@ -533,7 +533,7 @@ export declare const DateTimeUpdateFromNumber: DateTimeUpdateFromNumber;
  * Variant field type for a JSON value stored as text in database variants and
  * exposed through the supplied schema in JSON variants.
  *
- * @category json
+ * @category models
  * @since 4.0.0
  */
 export interface JsonFromString<S extends Schema.Top> extends VariantSchema.Field<{
@@ -552,7 +552,7 @@ export interface JsonFromString<S extends Schema.Top> extends VariantSchema.Fiel
  *
  * The "json" variants will use the object schema directly.
  *
- * @category json
+ * @category constructors
  * @since 4.0.0
  */
 export declare const JsonFromString: <S extends Schema.Top>(schema: S) => JsonFromString<S>;

package/dist/unstable/schema/Model.js

@@ -393,7 +393,7 @@ export const DateTimeUpdateFromNumber = /*#__PURE__*/Field({
  *
  * The "json" variants will use the object schema directly.
  *
- * @category json
+ * @category constructors
  * @since 4.0.0
  */
 export const JsonFromString = schema => {

package/dist/unstable/socket/Socket.d.ts

@@ -55,7 +55,7 @@ export declare const isSocket: (u: unknown) => u is Socket;
  * Use to access or provide the socket implementation used by programs that
  * read and write frames through the Effect environment.
  *
- * @category tags
+ * @category services
  * @since 4.0.0
  */
 export declare const Socket: Context.Service<Socket, Socket>;
@@ -341,7 +341,7 @@ declare const WebSocket_base: Context.ServiceClass<WebSocket, "~effect/socket/So
  * Context service for the active `WebSocket` instance available while a
  * WebSocket-backed socket run is handling events.
  *
- * @category tags
+ * @category services
  * @since 4.0.0
  */
 export declare class WebSocket extends WebSocket_base {
@@ -351,7 +351,7 @@ declare const WebSocketConstructor_base: Context.ServiceClass<WebSocketConstruct
  * Context service for constructing `WebSocket` instances from a URL and
  * optional protocols.
  *
- * @category tags
+ * @category services
  * @since 4.0.0
  */
 export declare class WebSocketConstructor extends WebSocketConstructor_base {

package/dist/unstable/socket/Socket.js

@@ -35,7 +35,7 @@ export const isSocket = u => Predicate.hasProperty(u, TypeId);
  * Use to access or provide the socket implementation used by programs that
  * read and write frames through the Effect environment.
  *
- * @category tags
+ * @category services
  * @since 4.0.0
  */
 export const Socket = /*#__PURE__*/Context.Service("effect/socket/Socket");
@@ -318,7 +318,7 @@ export const defaultCloseCodeIsError = _code => true;
  * Context service for the active `WebSocket` instance available while a
  * WebSocket-backed socket run is handling events.
  *
- * @category tags
+ * @category services
  * @since 4.0.0
  */
 export class WebSocket extends /*#__PURE__*/Context.Service()("~effect/socket/Socket/WebSocket") {}
@@ -326,7 +326,7 @@ export class WebSocket extends /*#__PURE__*/Context.Service()("~effect/socket/So
  * Context service for constructing `WebSocket` instances from a URL and
  * optional protocols.
  *
- * @category tags
+ * @category services
  * @since 4.0.0
  */
 export class WebSocketConstructor extends /*#__PURE__*/Context.Service()("@effect/platform/Socket/WebSocketConstructor") {}

package/dist/unstable/socket/SocketServer.d.ts

@@ -34,7 +34,7 @@ declare const SocketServer_base: Context.ServiceClass<SocketServer, "@effect/pla
  * Context service for a socket server, exposing its bound address and a run
  * loop that handles each accepted `Socket`.
  *
- * @category tags
+ * @category services
  * @since 4.0.0
  */
 export declare class SocketServer extends SocketServer_base {

package/dist/unstable/socket/SocketServer.js

@@ -29,7 +29,7 @@ import * as Data from "../../Data.js";
  * Context service for a socket server, exposing its bound address and a run
  * loop that handles each accepted `Socket`.
  *
- * @category tags
+ * @category services
  * @since 4.0.0
  */
 export class SocketServer extends /*#__PURE__*/Context.Service()("@effect/platform/SocketServer") {}

package/dist/unstable/sql/Migrator.d.ts

@@ -6,7 +6,7 @@ import type { SqlError } from "./SqlError.ts";
  * Options for running SQL migrations, including the migration loader, optional
  * schema dump directory, and migrations table name.
  *
- * @category models
+ * @category options
  * @since 4.0.0
  */
 export interface MigratorOptions<R = never> {

package/dist/unstable/sql/SqlClient.d.ts

@@ -55,7 +55,7 @@ export interface SqlClient extends Constructor {
  * Use to access or provide the SQL client used to build statements, stream
  * rows, reserve connections, and run transactions.
  *
- * @category tags
+ * @category services
  * @since 4.0.0
  */
 export declare const SqlClient: Context.Service<SqlClient, SqlClient>;
@@ -70,7 +70,7 @@ export declare namespace SqlClient {
      * the SQL compiler, transaction SQL, row transformation, tracing attributes,
      * and optional reactive query integration.
      *
-     * @category models
+     * @category options
      * @since 4.0.0
      */
     interface MakeOptions {
@@ -144,7 +144,7 @@ export declare namespace TransactionConnection {
  * Creates a unique context service tag for the active transaction connection of
  * a specific SQL client.
  *
- * @category tags
+ * @category services
  * @since 4.0.0
  */
 export declare const TransactionConnection: (clientId: number) => Context.Service<TransactionConnection, TransactionConnection.Service>;

package/dist/unstable/sql/SqlClient.js

@@ -41,7 +41,7 @@ const TypeId = "~effect/sql/SqlClient";
  * Use to access or provide the SQL client used to build statements, stream
  * rows, reserve connections, and run transactions.
  *
- * @category tags
+ * @category services
  * @since 4.0.0
  */
 export const SqlClient = /*#__PURE__*/Context.Service("effect/sql/SqlClient");
@@ -145,7 +145,7 @@ export const makeWithTransaction = options => effect => {
  * Creates a unique context service tag for the active transaction connection of
  * a specific SQL client.
  *
- * @category tags
+ * @category services
  * @since 4.0.0
  */
 export const TransactionConnection = clientId => Context.Service(`effect/sql/SqlClient/TransactionConnection/${clientId}`);

package/dist/unstable/sql/SqlConnection.d.ts

@@ -56,7 +56,7 @@ export type Acquirer = Effect<Connection, SqlError, Scope>;
 /**
  * Service tag for a low-level SQL `Connection`.
  *
- * @category tag
+ * @category services
  * @since 4.0.0
  */
 export declare const Connection: Context.Service<Connection, Connection>;

package/dist/unstable/sql/SqlConnection.js

@@ -25,7 +25,7 @@ import * as Context from "../../Context.js";
 /**
  * Service tag for a low-level SQL `Connection`.
  *
- * @category tag
+ * @category services
  * @since 4.0.0
  */
 export const Connection = /*#__PURE__*/Context.Service("effect/sql/SqlConnection");

package/dist/unstable/sql/Statement.d.ts

@@ -69,14 +69,14 @@ export declare const CurrentTransformer: Context.Reference<Transformer | undefin
 /**
  * Returns `true` when a value is a SQL `Fragment`.
  *
- * @category guard
+ * @category guards
  * @since 4.0.0
  */
 export declare const isFragment: (u: unknown) => u is Fragment;
 /**
  * Creates a type guard for custom SQL segments with the specified custom kind.
  *
- * @category guard
+ * @category guards
  * @since 4.0.0
  */
 export declare const isCustom: <A extends Custom<any, any, any, any>>(kind: A["kind"]) => (u: unknown) => u is A;

package/dist/unstable/sql/Statement.js

@@ -71,14 +71,14 @@ export const CurrentTransformer = /*#__PURE__*/Context.Reference("effect/sql/Cur
 /**
  * Returns `true` when a value is a SQL `Fragment`.
  *
- * @category guard
+ * @category guards
  * @since 4.0.0
  */
 export const isFragment = u => hasProperty(u, FragmentTypeId);
 /**
  * Creates a type guard for custom SQL segments with the specified custom kind.
  *
- * @category guard
+ * @category guards
  * @since 4.0.0
  */
 export const isCustom = kind => u => hasProperty(u, "_tag") && u._tag === "Custom" && u.kind === kind;

package/dist/unstable/workers/Transferable.d.ts

@@ -80,7 +80,7 @@ export declare const addAll: (tranferables: Iterable<globalThis.Transferable>) =
  * Creates a schema getter that records transferables derived from a value in
  * the current `Collector` while passing the value through unchanged.
  *
- * @category Getter
+ * @category getters
  * @since 4.0.0
  */
 export declare const getterAddAll: <A>(f: (_: A) => Iterable<globalThis.Transferable>) => Getter.Getter<A, A>;

package/dist/unstable/workers/Transferable.js

@@ -96,7 +96,7 @@ export const addAll = tranferables => Effect.contextWith(services => {
  * Creates a schema getter that records transferables derived from a value in
  * the current `Collector` while passing the value through unchanged.
  *
- * @category Getter
+ * @category getters
  * @since 4.0.0
  */
 export const getterAddAll = f => Getter.transformOrFail(e => Effect.contextWith(services => {

package/dist/unstable/workers/Worker.d.ts

@@ -103,7 +103,7 @@ export interface Spawner {
 /**
  * Service tag for the worker `SpawnerFn`.
  *
- * @category tags
+ * @category services
  * @since 4.0.0
  */
 export declare const Spawner: Context.Service<Spawner, SpawnerFn<unknown>>;

package/dist/unstable/workers/Worker.js

@@ -74,7 +74,7 @@ export const makeUnsafe = options => ({
 /**
  * Service tag for the worker `SpawnerFn`.
  *
- * @category tags
+ * @category services
  * @since 4.0.0
  */
 export const Spawner = /*#__PURE__*/Context.Service("effect/workers/Worker/Spawner");

package/dist/unstable/workflow/Activity.d.ts

@@ -140,7 +140,7 @@ export declare const idempotencyKey: (name: string, options?: {
  * Runs a non-empty collection of activities as a durable race and returns the
  * first completed success or failure using unioned success and error schemas.
  *
- * @category Racing
+ * @category racing
  * @since 4.0.0
  */
 export declare const raceAll: <const Activities extends NonEmptyReadonlyArray<Any>>(name: string, activities: Activities) => Effect.Effect<Activities[number] extends Activity<infer _A, infer _E, infer _R> ? _A["Type"] : never, Activities[number] extends Activity<infer _A, infer _E_1, infer _R_1> ? _E_1["Type"] : never, (Activities[number] extends Activity<infer Success, infer Error, infer R> ? Success["DecodingServices"] | Error["DecodingServices"] | R : never) | WorkflowEngine | WorkflowInstance>;

package/dist/unstable/workflow/Activity.js

@@ -105,7 +105,7 @@ export const idempotencyKey = /*#__PURE__*/Effect.fnUntraced(function* (name, op
  * Runs a non-empty collection of activities as a durable race and returns the
  * first completed success or failure using unioned success and error schemas.
  *
- * @category Racing
+ * @category racing
  * @since 4.0.0
  */
 export const raceAll = (name, activities) => DurableDeferred.raceAll({

package/dist/unstable/workflow/DurableDeferred.d.ts

@@ -97,7 +97,7 @@ export declare const into: {
  * Runs effects as a durable race, returning a previously persisted result when
  * present or completing a named deferred with the first result.
  *
- * @category Racing
+ * @category racing
  * @since 4.0.0
  */
 export declare const raceAll: <const Effects extends NonEmptyReadonlyArray<Effect.Effect<any, any, any>>, Success extends Schema.Schema<Effect.Success<Effects[number]>>, Error extends Schema.Schema<Effect.Error<Effects[number]>>>(options: {

package/dist/unstable/workflow/DurableDeferred.js

@@ -118,7 +118,7 @@ export const into = /*#__PURE__*/dual(2, (effect, self) => Effect.contextWith(co
  * Runs effects as a durable race, returning a previously persisted result when
  * present or completing a named deferred with the first result.
  *
- * @category Racing
+ * @category racing
  * @since 4.0.0
  */
 export const raceAll = options => {

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "effect",
   "type": "module",
-  "version": "4.0.0-beta.72",
+  "version": "4.0.0-beta.74",
   "license": "MIT",
   "description": "The missing standard library for TypeScript, for writing production-grade software.",
   "homepage": "https://effect.website",