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

package/src/unstable/reactivity/Reactivity.ts

@@ -66,7 +66,7 @@ import * as Stream from "../../Stream.ts"
  * 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 Context.Service<

package/src/unstable/rpc/Rpc.ts

@@ -1027,7 +1027,7 @@ export const make = <
  * })
  * ```
  *
- * @category Custom constructors
+ * @category constructors
  * @since 4.0.0
  */
 export const custom = <Def extends Custom>(
@@ -1080,7 +1080,7 @@ export const custom = <Def extends Custom>(
  * 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 {
@@ -1099,7 +1099,7 @@ export declare namespace Custom {
   /**
    * The transformed schemas produced by a custom RPC constructor.
    *
-   * @category Custom constructors
+   * @category constructors
    * @since 4.0.0
    */
   export interface Out<
@@ -1115,7 +1115,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
    */
   export type OutDefault = Out<Schema.Top, Schema.Top>
@@ -1124,7 +1124,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
    */
   export type Kind<

package/src/unstable/rpc/RpcMiddleware.ts

@@ -279,7 +279,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 const Service = <

package/src/unstable/rpc/RpcSchema.ts

@@ -48,7 +48,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: Schema.Top): schema is Stream<Schema.Top, Schema.Top> {
@@ -72,7 +72,7 @@ export function getStreamSchemas(schema: Schema.Top): Option.Option<{
  * 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
@@ -97,7 +97,7 @@ const schema = 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<A extends Schema.Top, E extends Schema.Top>(success: A, error: E): Stream<A, E> {

package/src/unstable/schema/Model.ts

@@ -670,7 +670,7 @@ export const DateTimeUpdateFromNumber: DateTimeUpdateFromNumber = Field({
  * 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
@@ -691,7 +691,7 @@ export interface JsonFromString<S extends Schema.Top> extends
  *
  * The "json" variants will use the object schema directly.
  *
- * @category json
+ * @category constructors
  * @since 4.0.0
  */
 export const JsonFromString = <S extends Schema.Top>(

package/src/unstable/socket/Socket.ts

@@ -66,7 +66,7 @@ export const isSocket = (u: unknown): u is Socket => Predicate.hasProperty(u, Ty
  * 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: Context.Service<Socket, Socket> = Context.Service<Socket>("effect/socket/Socket")
@@ -567,7 +567,7 @@ export const defaultCloseCodeIsError = (_code: number) => 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 Context.Service<WebSocket, globalThis.WebSocket>()(
@@ -578,7 +578,7 @@ export class WebSocket extends Context.Service<WebSocket, globalThis.WebSocket>(
  * Context service for constructing `WebSocket` instances from a URL and
  * optional protocols.
  *
- * @category tags
+ * @category services
  * @since 4.0.0
  */
 export class WebSocketConstructor extends Context.Service<

package/src/unstable/socket/SocketServer.ts

@@ -32,7 +32,7 @@ import type * as Socket from "./Socket.ts"
  * 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 Context.Service<SocketServer, {

package/src/unstable/sql/Migrator.ts

@@ -57,7 +57,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/src/unstable/sql/SqlClient.ts

@@ -102,7 +102,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 const SqlClient = Context.Service<SqlClient>("effect/sql/SqlClient")
@@ -118,7 +118,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
    */
   export interface MakeOptions {
@@ -336,7 +336,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 const TransactionConnection = (

package/src/unstable/sql/SqlConnection.ts

@@ -81,7 +81,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 const Connection = Context.Service<Connection>("effect/sql/SqlConnection")

package/src/unstable/sql/Statement.ts

@@ -135,7 +135,7 @@ export const CurrentTransformer = Context.Reference<Transformer | undefined>("ef
 /**
  * Returns `true` when a value is a SQL `Fragment`.
  *
- * @category guard
+ * @category guards
  * @since 4.0.0
  */
 export const isFragment = (u: unknown): u is Fragment => hasProperty(u, FragmentTypeId)
@@ -143,7 +143,7 @@ export const isFragment = (u: unknown): u is Fragment => hasProperty(u, Fragment
 /**
  * Creates a type guard for custom SQL segments with the specified custom kind.
  *
- * @category guard
+ * @category guards
  * @since 4.0.0
  */
 export const isCustom = <A extends Custom<any, any, any, any>>(

package/src/unstable/workers/Transferable.ts

@@ -113,7 +113,7 @@ export const addAll = (
  * 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 = <A>(

package/src/unstable/workers/Worker.ts

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

package/src/unstable/workflow/Activity.ts

@@ -284,7 +284,7 @@ export const idempotencyKey: (
  * 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 = <const Activities extends NonEmptyReadonlyArray<Any>>(

package/src/unstable/workflow/DurableDeferred.ts

@@ -273,7 +273,7 @@ export 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 const raceAll = <