effect 4.0.0-beta.67 → 4.0.0-beta.68

package/src/Order.ts

@@ -324,7 +324,7 @@ export const BigInt: Order<bigint> = make((self, that) => self < that ? -1 : 1)
  * - {@link combine} - Combine orders for multi-criteria comparison
  *
  * @category combinators
- * @since 2.0.0
+ * @since 4.0.0
  */
 export function flip<A>(O: Order<A>): Order<A> {
   return make((self, that) => O(that, self))
@@ -906,7 +906,7 @@ export function Struct<const R extends { readonly [x: string]: Order<any> }>(
  * - {@link isGreaterThan} - Strict greater than
  *
  * @category predicates
- * @since 2.0.0
+ * @since 4.0.0
  */
 export const isLessThan = <A>(O: Order<A>): {
   (that: A): (self: A) => boolean
@@ -944,7 +944,7 @@ export const isLessThan = <A>(O: Order<A>): {
  * - {@link isLessThan} - Strict less than
  *
  * @category predicates
- * @since 2.0.0
+ * @since 4.0.0
  */
 export const isGreaterThan = <A>(O: Order<A>): {
   (that: A): (self: A) => boolean
@@ -982,7 +982,7 @@ export const isGreaterThan = <A>(O: Order<A>): {
  * - {@link isGreaterThan} - Strict greater than
  *
  * @category predicates
- * @since 2.0.0
+ * @since 4.0.0
  */
 export const isLessThanOrEqualTo = <A>(O: Order<A>): {
   (that: A): (self: A) => boolean
@@ -1020,7 +1020,7 @@ export const isLessThanOrEqualTo = <A>(O: Order<A>): {
  * - {@link isLessThanOrEqualTo} - Less than or equal
  *
  * @category predicates
- * @since 2.0.0
+ * @since 4.0.0
  */
 export const isGreaterThanOrEqualTo = <A>(O: Order<A>): {
   (that: A): (self: A) => boolean
@@ -1243,7 +1243,7 @@ export const isBetween = <A>(O: Order<A>): {
  * - {@link combineAll} - Combine multiple orders
  * - {@link Reducer} - Reducer type for collection operations
  *
- * @category utilities
+ * @category utils
  * @since 4.0.0
  */
 export function makeReducer<A>() {

package/src/Ordering.ts

@@ -31,8 +31,6 @@
  *   right value, while `1` means it should come after
  * - Reversing an `Ordering` swaps `-1` and `1`, but leaves `0` unchanged
  *
- * @fileoverview
- * @category utilities
  * @since 2.0.0
  */
 import type { LazyArg } from "./Function.ts"
@@ -68,7 +66,7 @@ import * as Reducer_ from "./Reducer.ts"
  * }
  * ```
  *
- * @category model
+ * @category models
  * @since 2.0.0
  */
 export type Ordering = -1 | 0 | 1
@@ -105,7 +103,7 @@ export type Ordering = -1 | 0 | 1
  * }
  * ```
  *
- * @category transformations
+ * @category transforming
  * @since 2.0.0
  */
 export const reverse = (o: Ordering): Ordering => (o === -1 ? 1 : o === 1 ? -1 : 0)
@@ -116,14 +114,13 @@ export const reverse = (o: Ordering): Ordering => (o === -1 ? 1 : o === 1 ? -1 :
  * **Example** (Pattern matching on orderings)
  *
  * ```ts
- * import { Ordering } from "effect"
- * import { constant } from "effect/Function"
+ * import { Function, Ordering } from "effect"
  * import * as assert from "node:assert"
  *
  * const toMessage = Ordering.match({
- *   onLessThan: constant("less than"),
- *   onEqual: constant("equal"),
- *   onGreaterThan: constant("greater than")
+ *   onLessThan: Function.constant("less than"),
+ *   onEqual: Function.constant("equal"),
+ *   onGreaterThan: Function.constant("greater than")
  * })
  *
  * assert.deepStrictEqual(toMessage(-1), "less than")
@@ -141,14 +138,13 @@ export const match: {
    * **Example** (Pattern matching on orderings)
    *
    * ```ts
-   * import { Ordering } from "effect"
-   * import { constant } from "effect/Function"
+   * import { Function, Ordering } from "effect"
    * import * as assert from "node:assert"
    *
    * const toMessage = Ordering.match({
-   *   onLessThan: constant("less than"),
-   *   onEqual: constant("equal"),
-   *   onGreaterThan: constant("greater than")
+   *   onLessThan: Function.constant("less than"),
+   *   onEqual: Function.constant("equal"),
+   *   onGreaterThan: Function.constant("greater than")
    * })
    *
    * assert.deepStrictEqual(toMessage(-1), "less than")
@@ -172,14 +168,13 @@ export const match: {
    * **Example** (Pattern matching on orderings)
    *
    * ```ts
-   * import { Ordering } from "effect"
-   * import { constant } from "effect/Function"
+   * import { Function, Ordering } from "effect"
    * import * as assert from "node:assert"
    *
    * const toMessage = Ordering.match({
-   *   onLessThan: constant("less than"),
-   *   onEqual: constant("equal"),
-   *   onGreaterThan: constant("greater than")
+   *   onLessThan: Function.constant("less than"),
+   *   onEqual: Function.constant("equal"),
+   *   onGreaterThan: Function.constant("greater than")
    * })
    *
    * assert.deepStrictEqual(toMessage(-1), "less than")
@@ -213,6 +208,7 @@ export const match: {
  * If any of the `Ordering`s is non-zero, the result is the first non-zero `Ordering`.
  * If all the `Ordering`s are zero, the result is zero.
  *
+ * @category ordering
  * @since 4.0.0
  */
 export const Reducer: Reducer_.Reducer<Ordering> = Reducer_.make<Ordering>(

package/src/PartitionedSemaphore.ts

@@ -74,7 +74,7 @@ export type PartitionedTypeId = "~effect/PartitionedSemaphore"
  * Waiting permits are distributed across partitions in round-robin order.
  *
  * @category models
- * @since 4.0.0
+ * @since 3.19.4
  */
 export interface PartitionedSemaphore<in K> {
   readonly [PartitionedTypeId]: PartitionedTypeId
@@ -121,7 +121,7 @@ export interface Partitioned<in K> extends PartitionedSemaphore<K> {}
  * workflow.
  *
  * @category constructors
- * @since 4.0.0
+ * @since 3.19.4
  */
 export const makeUnsafe = <K = unknown>(options: {
   readonly permits: number
@@ -320,7 +320,7 @@ export const makeUnsafe = <K = unknown>(options: {
  * across waiting partitions in round-robin order.
  *
  * @category constructors
- * @since 4.0.0
+ * @since 3.19.4
  */
 export const make = <K = unknown>(options: {
   readonly permits: number

package/src/Path.ts

@@ -40,6 +40,7 @@ import { BadArgument } from "./PlatformError.ts"
 /**
  * Runtime type identifier used to mark implementations of the `Path` service.
  *
+ * @category type IDs
  * @since 4.0.0
  */
 export const TypeId = "~effect/platform/Path"
@@ -84,7 +85,7 @@ export const TypeId = "~effect/platform/Path"
  * })
  * ```
  *
- * @category model
+ * @category models
  * @since 4.0.0
  */
 export interface Path {
@@ -133,7 +134,6 @@ export interface Path {
  * })
  * ```
  *
- * @category namespace
  * @since 4.0.0
  */
 export declare namespace Path {
@@ -173,7 +173,7 @@ export declare namespace Path {
    * })
    * ```
    *
-   * @category model
+   * @category models
    * @since 4.0.0
    */
   export interface Parsed {
@@ -850,7 +850,7 @@ const posixImpl = Path.of({
  * Use this layer when an effect requires the `Path` service and should use
  * forward-slash path semantics.
  *
- * @category Layers
+ * @category layers
  * @since 4.0.0
  */
 export const layer: Layer.Layer<Path> = Layer.succeed(Path)(posixImpl)

package/src/Pipeable.ts

@@ -29,8 +29,6 @@
  * left to right, returning the final result. Many Effect data types implement
  * this so operations can be chained without nesting function calls.
  *
- * @category models
- * @since 2.0.0
  * **Example** (Chaining operations with pipe)
  *
  * ```ts
@@ -43,6 +41,9 @@
  *   Effect.tap((x) => Effect.log(`Result: ${x}`))
  * )
  * ```
+ *
+ * @category models
+ * @since 2.0.0
  */
 export interface Pipeable {
   pipe<A>(this: A): A
@@ -534,8 +535,6 @@ export interface Pipeable {
  * receive JavaScript's `arguments` object. With no functions it returns the
  * original value; otherwise it feeds each result into the next function.
  *
- * @category utilities
- * @since 2.0.0
  * **Example** (Implementing a pipe method)
  *
  * ```ts
@@ -555,6 +554,9 @@ export interface Pipeable {
  * )
  * console.log(result) // 21
  * ```
+ *
+ * @category utils
+ * @since 2.0.0
  */
 export const pipeArguments = <A>(self: A, args: IArguments): unknown => {
   switch (args.length) {
@@ -594,7 +596,8 @@ export const pipeArguments = <A>(self: A, args: IArguments): unknown => {
  * Classes or object prototypes can reuse this value when they need the
  * standard pipe implementation backed by `pipeArguments`.
  *
- * @since 4.0.0
+ * @category models
+ * @since 3.15.0
  */
 export const Prototype: Pipeable = {
   pipe() {
@@ -610,7 +613,7 @@ export const Prototype: Pipeable = {
  * Effect-style method chaining through `.pipe(...)`.
  *
  * @category constructors
- * @since 4.0.0
+ * @since 3.15.0
  */
 export const Class: new() => Pipeable = (function() {
   function PipeableBase() {}
@@ -622,7 +625,7 @@ export const Class: new() => Pipeable = (function() {
  * Constructor type for classes whose instances implement `Pipeable`.
  *
  * @category models
- * @since 4.0.0
+ * @since 3.15.0
  */
 export interface PipeableConstructor {
   new(...args: ReadonlyArray<any>): Pipeable

package/src/PlatformError.ts

@@ -41,7 +41,7 @@ const TypeId = "~effect/platform/PlatformError"
  * The error records the module and method that rejected the argument, with an
  * optional description and cause. It is usually wrapped in `PlatformError`.
  *
- * @category Models
+ * @category models
  * @since 4.0.0
  */
 export class BadArgument extends Data.TaggedError("BadArgument")<{
@@ -66,7 +66,7 @@ export class BadArgument extends Data.TaggedError("BadArgument")<{
  * The tags group lower-level platform errors into a stable set such as
  * `NotFound`, `PermissionDenied`, `TimedOut`, and `Unknown`.
  *
- * @category Model
+ * @category models
  * @since 4.0.0
  */
 export type SystemErrorTag =
@@ -120,7 +120,7 @@ export class SystemError extends Data.Error<{
  * The `reason` field contains the underlying `BadArgument` or `SystemError`.
  * When that reason has a cause, the cause is preserved on the wrapper.
  *
- * @category Models
+ * @category models
  * @since 4.0.0
  */
 export class PlatformError extends Data.TaggedError("PlatformError")<{

package/src/Predicate.ts

@@ -27,7 +27,7 @@
  * **Example** (Filter by a predicate)
  *
  * ```ts
- * import * as Predicate from "effect/Predicate"
+ * import { Predicate } from "effect"
  *
  * const isPositive = (n: number) => n > 0
  * const data = [2, -1, 3]
@@ -161,7 +161,6 @@ export interface Refinement<in A, out B extends A> {
  *
  * See also: {@link Predicate}, {@link Refinement}
  *
- * @category type-level
  * @since 3.6.0
  */
 export declare namespace Predicate {
@@ -240,7 +239,6 @@ export declare namespace Predicate {
  *
  * See also: {@link Refinement}, {@link Predicate}
  *
- * @category type-level
  * @since 3.6.0
  */
 export declare namespace Refinement {
@@ -1179,7 +1177,7 @@ export function isObjectOrArray(input: unknown): input is { [x: PropertyKey]: un
  * See also: {@link isObjectOrArray}, {@link isReadonlyObject}
  *
  * @category guards
- * @since 4.0.0
+ * @since 2.0.0
  */
 export function isObject(input: unknown): input is { [x: PropertyKey]: unknown } {
   return typeof input === "object" && input !== null && !Array.isArray(input)
@@ -1234,7 +1232,7 @@ export function isReadonlyObject(input: unknown): input is { readonly [x: Proper
  * See also: {@link isObject}, {@link isObjectOrArray}
  *
  * @category guards
- * @since 2.0.0
+ * @since 4.0.0
  */
 export function isObjectKeyword(input: unknown): input is object {
   return (typeof input === "object" && input !== null) || isFunction(input)

package/src/PrimaryKey.ts

@@ -15,6 +15,7 @@ import { hasProperty } from "./Predicate.ts"
 /**
  * The unique identifier used to identify objects that implement the `PrimaryKey` interface.
  *
+ * @category symbols
  * @since 2.0.0
  */
 export const symbol = "~effect/interfaces/PrimaryKey"
@@ -56,7 +57,7 @@ export interface PrimaryKey {
  * call the method or verify that it returns a string.
  *
  * @category models
- * @since 2.0.0
+ * @since 4.0.0
  */
 export const isPrimaryKey = (u: unknown): u is PrimaryKey => hasProperty(u, symbol)
 

package/src/PubSub.ts

@@ -56,8 +56,7 @@ const TypeId = "~effect/PubSub"
  * **Example** (Publishing and subscribing to messages)
  *
  * ```ts
- * import { Effect } from "effect"
- * import * as PubSub from "effect/PubSub"
+ * import { Effect, PubSub } from "effect"
  *
  * const program = Effect.gen(function*() {
  *   // Create a bounded PubSub with capacity 10
@@ -226,8 +225,7 @@ const SubscriptionTypeId = "~effect/PubSub/Subscription"
  * **Example** (Taking messages from a subscription)
  *
  * ```ts
- * import { Effect } from "effect"
- * import * as PubSub from "effect/PubSub"
+ * import { Effect, PubSub } from "effect"
  *
  * const program = Effect.gen(function*() {
  *   const pubsub = yield* PubSub.bounded<string>(10)
@@ -276,8 +274,7 @@ export interface Subscription<out A> extends Pipeable {
  * **Example** (Creating a PubSub with a custom strategy)
  *
  * ```ts
- * import { Effect } from "effect"
- * import * as PubSub from "effect/PubSub"
+ * import { Effect, PubSub } from "effect"
  *
  * const program = Effect.gen(function*() {
  *   // Create custom PubSub with specific atomic implementation and strategy
@@ -320,15 +317,12 @@ export const make = <A>(
  * Pass an options object to configure both `capacity` and an optional replay
  * buffer for late subscribers.
  *
- * @param capacity - The maximum number of messages the PubSub can hold, or an options object
  *                   with capacity and optional replay buffer size
- * @returns An Effect that creates a bounded PubSub
  *
  * **Example** (Creating a bounded PubSub)
  *
  * ```ts
- * import { Effect } from "effect"
- * import * as PubSub from "effect/PubSub"
+ * import { Effect, PubSub } from "effect"
  *
  * const program = Effect.gen(function*() {
  *   // Create bounded PubSub with capacity 100
@@ -365,8 +359,7 @@ export const bounded = <A>(
  * **Example** (Dropping messages when full)
  *
  * ```ts
- * import { Effect } from "effect"
- * import * as PubSub from "effect/PubSub"
+ * import { Effect, PubSub } from "effect"
  *
  * const program = Effect.gen(function*() {
  *   // Create dropping PubSub that drops new messages when full
@@ -417,8 +410,7 @@ export const dropping = <A>(
  * **Example** (Sliding old messages when full)
  *
  * ```ts
- * import { Effect } from "effect"
- * import * as PubSub from "effect/PubSub"
+ * import { Effect, PubSub } from "effect"
  *
  * const program = Effect.gen(function*() {
  *   // Create sliding PubSub that evicts old messages when full
@@ -465,8 +457,7 @@ export const sliding = <A>(
  * **Example** (Creating an unbounded PubSub)
  *
  * ```ts
- * import { Effect } from "effect"
- * import * as PubSub from "effect/PubSub"
+ * import { Effect, PubSub } from "effect"
  *
  * const program = Effect.gen(function*() {
  *   // Create unbounded PubSub
@@ -542,8 +533,7 @@ export const makeAtomicUnbounded = <A>(options?: {
  * **Example** (Getting PubSub capacity)
  *
  * ```ts
- * import { Effect } from "effect"
- * import * as PubSub from "effect/PubSub"
+ * import { Effect, PubSub } from "effect"
  *
  * const program = Effect.gen(function*() {
  *   const pubsub = yield* PubSub.bounded<string>(100)
@@ -571,8 +561,7 @@ export const capacity = <A>(self: PubSub<A>): number => self.pubsub.capacity
  * **Example** (Getting PubSub size)
  *
  * ```ts
- * import { Effect } from "effect"
- * import * as PubSub from "effect/PubSub"
+ * import { Effect, PubSub } from "effect"
  *
  * const program = Effect.gen(function*() {
  *   const pubsub = yield* PubSub.bounded<string>(10)
@@ -622,7 +611,7 @@ export const size = <A>(self: PubSub<A>): Effect.Effect<number> => Effect.sync((
  * ```
  *
  * @category getters
- * @since 2.0.0
+ * @since 4.0.0
  */
 export const sizeUnsafe = <A>(self: PubSub<A>): number => {
   if (MutableRef.get(self.shutdownFlag)) {
@@ -639,8 +628,7 @@ export const sizeUnsafe = <A>(self: PubSub<A>): number => {
  * **Example** (Checking whether a PubSub is full)
  *
  * ```ts
- * import { Effect } from "effect"
- * import * as PubSub from "effect/PubSub"
+ * import { Effect, PubSub } from "effect"
  *
  * const program = Effect.gen(function*() {
  *   const pubsub = yield* PubSub.bounded<string>(2)
@@ -676,8 +664,7 @@ export const isFull = <A>(self: PubSub<A>): Effect.Effect<boolean> =>
  * **Example** (Checking whether a PubSub is empty)
  *
  * ```ts
- * import { Effect } from "effect"
- * import * as PubSub from "effect/PubSub"
+ * import { Effect, PubSub } from "effect"
  *
  * const program = Effect.gen(function*() {
  *   const pubsub = yield* PubSub.bounded<string>(10)
@@ -752,8 +739,7 @@ export const shutdown = <A>(self: PubSub<A>): Effect.Effect<void> =>
  * **Example** (Checking whether a PubSub is shutdown)
  *
  * ```ts
- * import { Effect } from "effect"
- * import * as PubSub from "effect/PubSub"
+ * import { Effect, PubSub } from "effect"
  *
  * const program = Effect.gen(function*() {
  *   const pubsub = yield* PubSub.bounded<string>(10)
@@ -847,8 +833,7 @@ export const awaitShutdown = <A>(self: PubSub<A>): Effect.Effect<void> => self.s
  * **Example** (Publishing a message)
  *
  * ```ts
- * import { Effect } from "effect"
- * import * as PubSub from "effect/PubSub"
+ * import { Effect, PubSub } from "effect"
  *
  * const program = Effect.gen(function*() {
  *   const pubsub = yield* PubSub.bounded<string>(10)
@@ -882,8 +867,7 @@ export const publish: {
    * **Example** (Publishing a message)
    *
    * ```ts
-   * import { Effect } from "effect"
-   * import * as PubSub from "effect/PubSub"
+   * import { Effect, PubSub } from "effect"
    *
    * const program = Effect.gen(function*() {
    *   const pubsub = yield* PubSub.bounded<string>(10)
@@ -917,8 +901,7 @@ export const publish: {
    * **Example** (Publishing a message)
    *
    * ```ts
-   * import { Effect } from "effect"
-   * import * as PubSub from "effect/PubSub"
+   * import { Effect, PubSub } from "effect"
    *
    * const program = Effect.gen(function*() {
    *   const pubsub = yield* PubSub.bounded<string>(10)
@@ -1066,8 +1049,7 @@ export const publishUnsafe: {
  * **Example** (Publishing multiple messages)
  *
  * ```ts
- * import { Effect, Fiber } from "effect"
- * import * as PubSub from "effect/PubSub"
+ * import { Effect, Fiber, PubSub } from "effect"
  *
  * const program = Effect.gen(function*() {
  *   const pubsub = yield* PubSub.bounded<string>(10)
@@ -1110,8 +1092,7 @@ export const publishAll: {
    * **Example** (Publishing multiple messages)
    *
    * ```ts
-   * import { Effect, Fiber } from "effect"
-   * import * as PubSub from "effect/PubSub"
+   * import { Effect, Fiber, PubSub } from "effect"
    *
    * const program = Effect.gen(function*() {
    *   const pubsub = yield* PubSub.bounded<string>(10)
@@ -1154,8 +1135,7 @@ export const publishAll: {
    * **Example** (Publishing multiple messages)
    *
    * ```ts
-   * import { Effect, Fiber } from "effect"
-   * import * as PubSub from "effect/PubSub"
+   * import { Effect, Fiber, PubSub } from "effect"
    *
    * const program = Effect.gen(function*() {
    *   const pubsub = yield* PubSub.bounded<string>(10)
@@ -1423,8 +1403,7 @@ const pollForItem = <A>(self: Subscription<A>) => {
  * **Example** (Taking up to a maximum number of messages)
  *
  * ```ts
- * import { Effect } from "effect"
- * import * as PubSub from "effect/PubSub"
+ * import { Effect, PubSub } from "effect"
  *
  * const program = Effect.gen(function*() {
  *   const pubsub = yield* PubSub.bounded<string>(10)
@@ -1460,8 +1439,7 @@ export const takeUpTo: {
    * **Example** (Taking up to a maximum number of messages)
    *
    * ```ts
-   * import { Effect } from "effect"
-   * import * as PubSub from "effect/PubSub"
+   * import { Effect, PubSub } from "effect"
    *
    * const program = Effect.gen(function*() {
    *   const pubsub = yield* PubSub.bounded<string>(10)
@@ -1497,8 +1475,7 @@ export const takeUpTo: {
    * **Example** (Taking up to a maximum number of messages)
    *
    * ```ts
-   * import { Effect } from "effect"
-   * import * as PubSub from "effect/PubSub"
+   * import { Effect, PubSub } from "effect"
    *
    * const program = Effect.gen(function*() {
    *   const pubsub = yield* PubSub.bounded<string>(10)
@@ -1696,8 +1673,7 @@ const takeRemainderLoop = <A>(
  * **Example** (Checking remaining messages)
  *
  * ```ts
- * import { Effect } from "effect"
- * import * as PubSub from "effect/PubSub"
+ * import { Effect, PubSub } from "effect"
  *
  * const program = Effect.gen(function*() {
  *   const pubsub = yield* PubSub.bounded<string>(10)
@@ -2749,8 +2725,7 @@ export class BackPressureStrategy<in out A> implements PubSub.Strategy<A> {
  * **Example** (Using a dropping strategy)
  *
  * ```ts
- * import { Effect } from "effect"
- * import * as PubSub from "effect/PubSub"
+ * import { Effect, PubSub } from "effect"
  *
  * const program = Effect.gen(function*() {
  *   // Create PubSub with dropping strategy
@@ -2827,8 +2802,7 @@ export class DroppingStrategy<in out A> implements PubSub.Strategy<A> {
  * **Example** (Using a sliding strategy)
  *
  * ```ts
- * import { Effect } from "effect"
- * import * as PubSub from "effect/PubSub"
+ * import { Effect, PubSub } from "effect"
  *
  * const program = Effect.gen(function*() {
  *   // Create PubSub with sliding strategy