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

package/src/Tuple.ts

@@ -95,7 +95,7 @@ import type { Apply, Lambda } from "./Struct.ts"
  * @see {@link get} – access a single element by index
  * @see {@link appendElement} – append an element to a tuple
  *
- * @category Constructors
+ * @category constructors
  * @since 2.0.0
  */
 export const make = <Elements extends ReadonlyArray<unknown>>(...elements: Elements): Elements => elements
@@ -121,7 +121,7 @@ type Indices<T extends ReadonlyArray<unknown>> = Exclude<Partial<T>["length"], T
  * @see {@link make} – create a tuple
  * @see {@link pick} – extract multiple elements into a new tuple
  *
- * @category Getters
+ * @category getters
  * @since 4.0.0
  */
 export const get: {
@@ -144,7 +144,7 @@ export const get: {
    * @see {@link make} – create a tuple
    * @see {@link pick} – extract multiple elements into a new tuple
    *
-   * @category Getters
+   * @category getters
    * @since 4.0.0
    */
   <const T extends ReadonlyArray<unknown>, I extends Indices<T> & keyof T>(index: I): (self: T) => T[I]
@@ -167,7 +167,7 @@ export const get: {
    * @see {@link make} – create a tuple
    * @see {@link pick} – extract multiple elements into a new tuple
    *
-   * @category Getters
+   * @category getters
    * @since 4.0.0
    */
   <const T extends ReadonlyArray<unknown>, I extends Indices<T> & keyof T>(self: T, index: I): T[I]
@@ -208,7 +208,7 @@ type PickTuple<T extends ReadonlyArray<unknown>, K> = _BuildTuple<T, K>
  * @see {@link omit} – the inverse (exclude indices instead)
  * @see {@link get} – extract a single element
  *
- * @category Utilities
+ * @category utils
  * @since 4.0.0
  */
 export const pick: {
@@ -231,7 +231,7 @@ export const pick: {
    * @see {@link omit} – the inverse (exclude indices instead)
    * @see {@link get} – extract a single element
    *
-   * @category Utilities
+   * @category utils
    * @since 4.0.0
    */
   <const T extends ReadonlyArray<unknown>, const I extends ReadonlyArray<Indices<T>>>(indices: I): (self: T) => PickTuple<T, I[number]>
@@ -254,7 +254,7 @@ export const pick: {
    * @see {@link omit} – the inverse (exclude indices instead)
    * @see {@link get} – extract a single element
    *
-   * @category Utilities
+   * @category utils
    * @since 4.0.0
    */
   <const T extends ReadonlyArray<unknown>, const I extends ReadonlyArray<Indices<T>>>(self: T, indices: I): PickTuple<T, I[number]>
@@ -288,7 +288,7 @@ type OmitTuple<T extends ReadonlyArray<unknown>, K> = _BuildTuple<T, Exclude<Ind
  *
  * @see {@link pick} – the inverse (keep only specified indices)
  *
- * @category Utilities
+ * @category utils
  * @since 4.0.0
  */
 export const omit: {
@@ -310,7 +310,7 @@ export const omit: {
    *
    * @see {@link pick} – the inverse (keep only specified indices)
    *
-   * @category Utilities
+   * @category utils
    * @since 4.0.0
    */
   <const T extends ReadonlyArray<unknown>, const I extends ReadonlyArray<Indices<T>>>(indices: I): (self: T) => OmitTuple<T, I[number]>
@@ -332,7 +332,7 @@ export const omit: {
    *
    * @see {@link pick} – the inverse (keep only specified indices)
    *
-   * @category Utilities
+   * @category utils
    * @since 4.0.0
    */
   <const T extends ReadonlyArray<unknown>, const I extends ReadonlyArray<Indices<T>>>(self: T, indices: I): OmitTuple<T, I[number]>
@@ -431,7 +431,7 @@ export const appendElement: {
  * @see {@link appendElement} – append a single element
  *
  * @category Concatenating
- * @since 2.0.0
+ * @since 4.0.0
  */
 export const appendElements: {
   /**
@@ -453,7 +453,7 @@ export const appendElements: {
    * @see {@link appendElement} – append a single element
    *
    * @category Concatenating
-   * @since 2.0.0
+   * @since 4.0.0
    */
   <const T2 extends ReadonlyArray<unknown>>(that: T2): <const T1 extends ReadonlyArray<unknown>>(self: T1) => [...T1, ...T2]
   /**
@@ -475,7 +475,7 @@ export const appendElements: {
    * @see {@link appendElement} – append a single element
    *
    * @category Concatenating
-   * @since 2.0.0
+   * @since 4.0.0
    */
   <const T1 extends ReadonlyArray<unknown>, const T2 extends ReadonlyArray<unknown>>(self: T1, that: T2): [...T1, ...T2]
 } = dual(
@@ -518,7 +518,7 @@ type Evolved<T, E> = { [I in keyof T]: I extends keyof E ? (E[I] extends (...a:
  * @see {@link map} – apply the same transformation to all elements
  * @see {@link renameIndices} – swap element positions
  *
- * @category Mapping
+ * @category mapping
  * @since 4.0.0
  */
 export const evolve: {
@@ -550,7 +550,7 @@ export const evolve: {
    * @see {@link map} – apply the same transformation to all elements
    * @see {@link renameIndices} – swap element positions
    *
-   * @category Mapping
+   * @category mapping
    * @since 4.0.0
    */
   <const T extends ReadonlyArray<unknown>, const E extends Evolver<T>>(evolver: E): (self: T) => Evolved<T, E>
@@ -582,7 +582,7 @@ export const evolve: {
    * @see {@link map} – apply the same transformation to all elements
    * @see {@link renameIndices} – swap element positions
    *
-   * @category Mapping
+   * @category mapping
    * @since 4.0.0
    */
   <const T extends ReadonlyArray<unknown>, const E extends Evolver<T>>(self: T, evolver: E): Evolved<T, E>
@@ -705,8 +705,8 @@ export const renameIndices: {
  * @see {@link mapOmit} – apply a lambda to all indices except selected ones
  * @see {@link evolve} – apply different functions to different indices
  *
- * @category Mapping
- * @since 4.0.0
+ * @category mapping
+ * @since 3.9.0
  */
 export const map: {
   /**
@@ -736,8 +736,8 @@ export const map: {
    * @see {@link mapOmit} – apply a lambda to all indices except selected ones
    * @see {@link evolve} – apply different functions to different indices
    *
-   * @category Mapping
-   * @since 4.0.0
+   * @category mapping
+   * @since 3.9.0
    */
   <L extends Lambda>(lambda: L): <const T extends ReadonlyArray<unknown>>(
     self: T
@@ -769,8 +769,8 @@ export const map: {
    * @see {@link mapOmit} – apply a lambda to all indices except selected ones
    * @see {@link evolve} – apply different functions to different indices
    *
-   * @category Mapping
-   * @since 4.0.0
+   * @category mapping
+   * @since 3.9.0
    */
   <const T extends ReadonlyArray<unknown>, L extends Lambda>(self: T, lambda: L): { [K in keyof T]: Apply<L, T[K]> }
 } = dual(
@@ -809,7 +809,7 @@ export const map: {
  * @see {@link map} – apply a lambda to all elements
  * @see {@link mapOmit} – apply a lambda to all elements except selected ones
  *
- * @category Mapping
+ * @category mapping
  * @since 4.0.0
  */
 export const mapPick: {
@@ -842,7 +842,7 @@ export const mapPick: {
    * @see {@link map} – apply a lambda to all elements
    * @see {@link mapOmit} – apply a lambda to all elements except selected ones
    *
-   * @category Mapping
+   * @category mapping
    * @since 4.0.0
    */
   <const T extends ReadonlyArray<unknown>, const I extends ReadonlyArray<Indices<T>>, L extends Lambda>(indices: I, lambda: L): (
@@ -877,7 +877,7 @@ export const mapPick: {
    * @see {@link map} – apply a lambda to all elements
    * @see {@link mapOmit} – apply a lambda to all elements except selected ones
    *
-   * @category Mapping
+   * @category mapping
    * @since 4.0.0
    */
   <const T extends ReadonlyArray<unknown>, const I extends ReadonlyArray<Indices<T>>, L extends Lambda>(self: T, indices: I, lambda: L): { [K in keyof T]: K extends `${I[number]}` ? Apply<L, T[K]> : T[K] }
@@ -922,7 +922,7 @@ export const mapPick: {
  * @see {@link map} – apply a lambda to all elements
  * @see {@link mapPick} – apply a lambda only to selected indices
  *
- * @category Mapping
+ * @category mapping
  * @since 4.0.0
  */
 export const mapOmit: {
@@ -955,7 +955,7 @@ export const mapOmit: {
    * @see {@link map} – apply a lambda to all elements
    * @see {@link mapPick} – apply a lambda only to selected indices
    *
-   * @category Mapping
+   * @category mapping
    * @since 4.0.0
    */
   <const T extends ReadonlyArray<unknown>, const I extends ReadonlyArray<Indices<T>>, L extends Lambda>(indices: I, lambda: L): (
@@ -990,7 +990,7 @@ export const mapOmit: {
    * @see {@link map} – apply a lambda to all elements
    * @see {@link mapPick} – apply a lambda only to selected indices
    *
-   * @category Mapping
+   * @category mapping
    * @since 4.0.0
    */
   <const T extends ReadonlyArray<unknown>, const I extends ReadonlyArray<Indices<T>>, L extends Lambda>(self: T, indices: I, lambda: L): { [K in keyof T]: K extends `${I[number]}` ? T[K] : Apply<L, T[K]> }
@@ -1032,7 +1032,7 @@ export const mapOmit: {
  * @see {@link makeOrder} – create an `Order` for tuples
  *
  * @category Equivalence
- * @since 2.0.0
+ * @since 4.0.0
  */
 export const makeEquivalence = Equivalence.Tuple
 
@@ -1059,7 +1059,7 @@ export const makeEquivalence = Equivalence.Tuple
  * @see {@link makeEquivalence} – create an `Equivalence` for tuples
  *
  * @category Ordering
- * @since 2.0.0
+ * @since 4.0.0
  */
 export const makeOrder = order.Tuple
 
@@ -1088,7 +1088,7 @@ export {
    *
    * @see {@link isTupleOfAtLeast} – check for a minimum length
    *
-   * @category Guards
+   * @category guards
    * @since 3.3.0
    */
   isTupleOf,
@@ -1116,7 +1116,7 @@ export {
    *
    * @see {@link isTupleOf} – check for an exact length
    *
-   * @category Guards
+   * @category guards
    * @since 3.3.0
    */
   isTupleOfAtLeast
@@ -1147,6 +1147,7 @@ export {
  *
  * @see {@link makeReducer} – like `makeCombiner` but with an initial value
  *
+ * @category combining
  * @since 4.0.0
  */
 export function makeCombiner<A extends ReadonlyArray<unknown>>(
@@ -1190,6 +1191,7 @@ export function makeCombiner<A extends ReadonlyArray<unknown>>(
  *
  * @see {@link makeCombiner} – like `makeReducer` but without an initial value
  *
+ * @category folding
  * @since 4.0.0
  */
 export function makeReducer<A extends ReadonlyArray<unknown>>(

package/src/TxChunk.ts

@@ -93,8 +93,6 @@ const TxChunkProto = {
  * **Return behavior**: This function returns a new TxChunk reference containing
  * the provided initial chunk. No existing TxChunk instances are modified.
  *
- * @category Constructors
- * @since 4.0.0
  * **Example** (Creating a TxChunk from a chunk)
  *
  * ```ts
@@ -110,6 +108,9 @@ const TxChunkProto = {
  *   console.log(Chunk.toReadonlyArray(result)) // [1, 2, 3]
  * })
  * ```
+ *
+ * @category constructors
+ * @since 4.0.0
  */
 export const make = <A>(initial: Chunk.Chunk<A>): Effect.Effect<TxChunk<A>> =>
   Effect.map(TxRef.make(initial), (ref) => makeUnsafe(ref))
@@ -120,8 +121,6 @@ export const make = <A>(initial: Chunk.Chunk<A>): Effect.Effect<TxChunk<A>> =>
  * **Return behavior**: This function returns a new TxChunk reference that is
  * initially empty. No existing TxChunk instances are modified.
  *
- * @category Constructors
- * @since 4.0.0
  * **Example** (Creating an empty TxChunk)
  *
  * ```ts
@@ -142,6 +141,9 @@ export const make = <A>(initial: Chunk.Chunk<A>): Effect.Effect<TxChunk<A>> =>
  *   console.log(isStillEmpty) // false
  * })
  * ```
+ *
+ * @category constructors
+ * @since 4.0.0
  */
 export const empty = <A = never>(): Effect.Effect<TxChunk<A>> =>
   Effect.map(TxRef.make(Chunk.empty<A>()), (ref) => makeUnsafe(ref))
@@ -152,8 +154,6 @@ export const empty = <A = never>(): Effect.Effect<TxChunk<A>> =>
  * **Return behavior**: This function returns a new TxChunk reference containing
  * elements from the provided iterable. No existing TxChunk instances are modified.
  *
- * @category Constructors
- * @since 4.0.0
  * **Example** (Creating from an iterable)
  *
  * ```ts
@@ -179,6 +179,9 @@ export const empty = <A = never>(): Effect.Effect<TxChunk<A>> =>
  *   console.log(Chunk.toReadonlyArray(updated)) // [0, 1, 2, 3, 4, 5, 6]
  * })
  * ```
+ *
+ * @category constructors
+ * @since 4.0.0
  */
 export const fromIterable = <A>(iterable: Iterable<A>): Effect.Effect<TxChunk<A>> =>
   Effect.map(TxRef.make(Chunk.fromIterable(iterable)), (ref) => makeUnsafe(ref))
@@ -215,8 +218,6 @@ export const makeUnsafe = <A>(ref: TxRef.TxRef<Chunk.Chunk<A>>): TxChunk<A> => {
  * **Mutation behavior**: This function mutates the original TxChunk by updating
  * its internal state. It does not return a new TxChunk reference.
  *
- * @category Combinators
- * @since 4.0.0
  * **Example** (Modifying while returning a value)
  *
  * ```ts
@@ -237,6 +238,9 @@ export const makeUnsafe = <A>(ref: TxRef.TxRef<Chunk.Chunk<A>>): TxChunk<A> => {
  *   console.log(Chunk.toReadonlyArray(newChunk)) // [1, 2, 3, 4]
  * })
  * ```
+ *
+ * @category combinators
+ * @since 4.0.0
  */
 export const modify: {
   /**
@@ -245,8 +249,6 @@ export const modify: {
    * **Mutation behavior**: This function mutates the original TxChunk by updating
    * its internal state. It does not return a new TxChunk reference.
    *
-   * @category Combinators
-   * @since 4.0.0
    * **Example** (Modifying while returning a value)
    *
    * ```ts
@@ -267,6 +269,9 @@ export const modify: {
    *   console.log(Chunk.toReadonlyArray(newChunk)) // [1, 2, 3, 4]
    * })
    * ```
+   *
+   * @category combinators
+   * @since 4.0.0
    */
   <A, R>(
     f: (current: Chunk.Chunk<NoInfer<A>>) => [returnValue: R, newValue: Chunk.Chunk<A>]
@@ -277,8 +282,6 @@ export const modify: {
    * **Mutation behavior**: This function mutates the original TxChunk by updating
    * its internal state. It does not return a new TxChunk reference.
    *
-   * @category Combinators
-   * @since 4.0.0
    * **Example** (Modifying while returning a value)
    *
    * ```ts
@@ -299,6 +302,9 @@ export const modify: {
    *   console.log(Chunk.toReadonlyArray(newChunk)) // [1, 2, 3, 4]
    * })
    * ```
+   *
+   * @category combinators
+   * @since 4.0.0
    */
   <A, R>(
     self: TxChunk<A>,
@@ -1413,8 +1419,6 @@ export const prependAll: {
  * **Mutation behavior**: This function mutates the original TxChunk by appending
  * all elements from the other TxChunk. It does not return a new TxChunk reference.
  *
- * @category Combinators
- * @since 4.0.0
  * **Example** (Concatenating TxChunks)
  *
  * ```ts
@@ -1435,6 +1439,9 @@ export const prependAll: {
  *   console.log(Chunk.toReadonlyArray(original)) // [4, 5, 6]
  * })
  * ```
+ *
+ * @category combinators
+ * @since 4.0.0
  */
 export const concat: {
   /**
@@ -1443,8 +1450,6 @@ export const concat: {
    * **Mutation behavior**: This function mutates the original TxChunk by appending
    * all elements from the other TxChunk. It does not return a new TxChunk reference.
    *
-   * @category Combinators
-   * @since 4.0.0
    * **Example** (Concatenating TxChunks)
    *
    * ```ts
@@ -1465,6 +1470,9 @@ export const concat: {
    *   console.log(Chunk.toReadonlyArray(original)) // [4, 5, 6]
    * })
    * ```
+   *
+   * @category combinators
+   * @since 4.0.0
    */
   <A>(other: TxChunk<A>): (self: TxChunk<A>) => Effect.Effect<void>
   /**
@@ -1473,8 +1481,6 @@ export const concat: {
    * **Mutation behavior**: This function mutates the original TxChunk by appending
    * all elements from the other TxChunk. It does not return a new TxChunk reference.
    *
-   * @category Combinators
-   * @since 4.0.0
    * **Example** (Concatenating TxChunks)
    *
    * ```ts
@@ -1495,6 +1501,9 @@ export const concat: {
    *   console.log(Chunk.toReadonlyArray(original)) // [4, 5, 6]
    * })
    * ```
+   *
+   * @category combinators
+   * @since 4.0.0
    */
   <A>(self: TxChunk<A>, other: TxChunk<A>): Effect.Effect<void>
 } = dual(

package/src/TxDeferred.ts

@@ -93,7 +93,7 @@ const makeTxDeferred = <A, E>(ref: TxRef.TxRef<Option<Result<A, E>>>): TxDeferre
  * ```
  *
  * @category constructors
- * @since 4.0.0
+ * @since 2.0.0
  */
 export const make = <A, E = never>(): Effect.Effect<TxDeferred<A, E>> =>
   Effect.map(TxRef.make<Option<Result<A, E>>>(O.none()), makeTxDeferred)
@@ -161,7 +161,7 @@ export {
  * ```
  *
  * @category getters
- * @since 4.0.0
+ * @since 2.0.0
  */
 export const poll = <A, E>(self: TxDeferred<A, E>): Effect.Effect<Option<Result<A, E>>> => TxRef.get(self.ref)
 
@@ -184,7 +184,7 @@ export const poll = <A, E>(self: TxDeferred<A, E>): Effect.Effect<Option<Result<
  * ```
  *
  * @category mutations
- * @since 4.0.0
+ * @since 2.0.0
  */
 export const done: {
   /**
@@ -206,7 +206,7 @@ export const done: {
    * ```
    *
    * @category mutations
-   * @since 4.0.0
+   * @since 2.0.0
    */
   <A, E>(result: Result<A, E>): (self: TxDeferred<A, E>) => Effect.Effect<boolean>
   /**
@@ -228,7 +228,7 @@ export const done: {
    * ```
    *
    * @category mutations
-   * @since 4.0.0
+   * @since 2.0.0
    */
   <A, E>(self: TxDeferred<A, E>, result: Result<A, E>): Effect.Effect<boolean>
 } = dual(
@@ -261,7 +261,7 @@ export const done: {
  * ```
  *
  * @category mutations
- * @since 4.0.0
+ * @since 2.0.0
  */
 export const succeed: {
   /**
@@ -283,7 +283,7 @@ export const succeed: {
    * ```
    *
    * @category mutations
-   * @since 4.0.0
+   * @since 2.0.0
    */
   <A>(value: A): <E>(self: TxDeferred<A, E>) => Effect.Effect<boolean>
   /**
@@ -305,7 +305,7 @@ export const succeed: {
    * ```
    *
    * @category mutations
-   * @since 4.0.0
+   * @since 2.0.0
    */
   <A, E>(self: TxDeferred<A, E>, value: A): Effect.Effect<boolean>
 } = dual(
@@ -332,7 +332,7 @@ export const succeed: {
  * ```
  *
  * @category mutations
- * @since 4.0.0
+ * @since 2.0.0
  */
 export const fail: {
   /**
@@ -354,7 +354,7 @@ export const fail: {
    * ```
    *
    * @category mutations
-   * @since 4.0.0
+   * @since 2.0.0
    */
   <E>(error: E): <A>(self: TxDeferred<A, E>) => Effect.Effect<boolean>
   /**
@@ -376,7 +376,7 @@ export const fail: {
    * ```
    *
    * @category mutations
-   * @since 4.0.0
+   * @since 2.0.0
    */
   <A, E>(self: TxDeferred<A, E>, error: E): Effect.Effect<boolean>
 } = dual(