effect 4.0.0-beta.67 → 4.0.0-beta.69

package/src/TxHashSet.ts

@@ -10,7 +10,7 @@
  * - Mutate an existing set with {@link add}, {@link remove}, and {@link clear}
  * - Query membership and size with {@link has}, {@link size}, and {@link isEmpty}
  * - Derive new sets with {@link map}, {@link filter}, {@link union}, {@link intersection}, and {@link difference}
- * - Fold or collect values with {@link reduce}, {@link toArray}, and {@link toHashSet}
+ * - Fold or collect values with {@link reduce} and {@link toHashSet}
  *
  * **Gotchas**
  *
@@ -103,7 +103,7 @@ const TxHashSetProto = {
  * ```
  *
  * @category models
- * @since 2.0.0
+ * @since 4.0.0
  */
 export interface TxHashSet<in out V> extends Inspectable, Pipeable {
   readonly [TypeId]: typeof TypeId
@@ -133,8 +133,7 @@ export interface TxHashSet<in out V> extends Inspectable, Pipeable {
  * })
  * ```
  *
- * @category models
- * @since 2.0.0
+ * @since 4.0.0
  */
 export declare namespace TxHashSet {
   /**
@@ -158,7 +157,7 @@ export declare namespace TxHashSet {
    * ```
    *
    * @category type-level
-   * @since 2.0.0
+   * @since 4.0.0
    */
   export type Value<T> = T extends TxHashSet<infer V> ? V : never
 }
@@ -268,8 +267,7 @@ export const fromIterable = <V>(values: Iterable<V>): Effect.Effect<TxHashSet<V>
  * **Example** (Creating a transactional hash set from a HashSet)
  *
  * ```ts
- * import { Effect, TxHashSet } from "effect"
- * import * as HashSet from "effect/HashSet"
+ * import { Effect, HashSet, TxHashSet } from "effect"
  *
  * const program = Effect.gen(function*() {
  *   const hashSet = HashSet.make("x", "y", "z")
@@ -286,7 +284,7 @@ export const fromIterable = <V>(values: Iterable<V>): Effect.Effect<TxHashSet<V>
  * ```
  *
  * @category constructors
- * @since 2.0.0
+ * @since 4.0.0
  */
 export const fromHashSet = <V>(hashSet: HashSet.HashSet<V>): Effect.Effect<TxHashSet<V>> =>
   Effect.gen(function*() {
@@ -300,8 +298,7 @@ export const fromHashSet = <V>(hashSet: HashSet.HashSet<V>): Effect.Effect<TxHas
  * **Example** (Checking for a TxHashSet)
  *
  * ```ts
- * import { Effect, TxHashSet } from "effect"
- * import * as HashSet from "effect/HashSet"
+ * import { Effect, HashSet, TxHashSet } from "effect"
  *
  * const program = Effect.gen(function*() {
  *   const txSet = yield* TxHashSet.make(1, 2, 3)
@@ -316,7 +313,7 @@ export const fromHashSet = <V>(hashSet: HashSet.HashSet<V>): Effect.Effect<TxHas
  * ```
  *
  * @category guards
- * @since 2.0.0
+ * @since 4.0.0
  */
 export const isTxHashSet = (u: unknown): u is TxHashSet<unknown> => hasProperty(u, TypeId)
 
@@ -883,7 +880,7 @@ export const isEmpty = <V>(self: TxHashSet<V>): Effect.Effect<boolean> =>
  * ```
  *
  * @category mutations
- * @since 2.0.0
+ * @since 4.0.0
  */
 export const clear = <V>(self: TxHashSet<V>): Effect.Effect<void> => TxRef.set(self.ref, HashSet.empty<V>())
 
@@ -1280,7 +1277,7 @@ export const difference: {
  * ```
  *
  * @category elements
- * @since 2.0.0
+ * @since 4.0.0
  */
 export const isSubset: {
   /**
@@ -1304,7 +1301,7 @@ export const isSubset: {
    * ```
    *
    * @category elements
-   * @since 2.0.0
+   * @since 4.0.0
    */
   <V1>(that: TxHashSet<V1>): <V0>(self: TxHashSet<V0>) => Effect.Effect<boolean>
   /**
@@ -1328,7 +1325,7 @@ export const isSubset: {
    * ```
    *
    * @category elements
-   * @since 2.0.0
+   * @since 4.0.0
    */
   <V0, V1>(self: TxHashSet<V0>, that: TxHashSet<V1>): Effect.Effect<boolean>
 } = dual<
@@ -1353,7 +1350,7 @@ export const isSubset: {
    * ```
    *
    * @category elements
-   * @since 2.0.0
+   * @since 4.0.0
    */
   <V1>(that: TxHashSet<V1>) => <V0>(self: TxHashSet<V0>) => Effect.Effect<boolean>,
   /**
@@ -1377,7 +1374,7 @@ export const isSubset: {
    * ```
    *
    * @category elements
-   * @since 2.0.0
+   * @since 4.0.0
    */
   <V0, V1>(self: TxHashSet<V0>, that: TxHashSet<V1>) => Effect.Effect<boolean>
 >(2, <V0, V1>(self: TxHashSet<V0>, that: TxHashSet<V1>) =>
@@ -1407,7 +1404,7 @@ export const isSubset: {
  * ```
  *
  * @category elements
- * @since 2.0.0
+ * @since 4.0.0
  */
 export const some: {
   /**
@@ -1430,7 +1427,7 @@ export const some: {
    * ```
    *
    * @category elements
-   * @since 2.0.0
+   * @since 4.0.0
    */
   <V>(predicate: Predicate<V>): (self: TxHashSet<V>) => Effect.Effect<boolean>
   /**
@@ -1453,7 +1450,7 @@ export const some: {
    * ```
    *
    * @category elements
-   * @since 2.0.0
+   * @since 4.0.0
    */
   <V>(self: TxHashSet<V>, predicate: Predicate<V>): Effect.Effect<boolean>
 } = dual<
@@ -1477,7 +1474,7 @@ export const some: {
    * ```
    *
    * @category elements
-   * @since 2.0.0
+   * @since 4.0.0
    */
   <V>(predicate: Predicate<V>) => (self: TxHashSet<V>) => Effect.Effect<boolean>,
   /**
@@ -1500,7 +1497,7 @@ export const some: {
    * ```
    *
    * @category elements
-   * @since 2.0.0
+   * @since 4.0.0
    */
   <V>(self: TxHashSet<V>, predicate: Predicate<V>) => Effect.Effect<boolean>
 >(2, <V>(self: TxHashSet<V>, predicate: Predicate<V>) =>
@@ -1529,7 +1526,7 @@ export const some: {
  * ```
  *
  * @category elements
- * @since 2.0.0
+ * @since 4.0.0
  */
 export const every: {
   /**
@@ -1552,7 +1549,7 @@ export const every: {
    * ```
    *
    * @category elements
-   * @since 2.0.0
+   * @since 4.0.0
    */
   <V>(predicate: Predicate<V>): (self: TxHashSet<V>) => Effect.Effect<boolean>
   /**
@@ -1575,7 +1572,7 @@ export const every: {
    * ```
    *
    * @category elements
-   * @since 2.0.0
+   * @since 4.0.0
    */
   <V>(self: TxHashSet<V>, predicate: Predicate<V>): Effect.Effect<boolean>
 } = dual<
@@ -1599,7 +1596,7 @@ export const every: {
    * ```
    *
    * @category elements
-   * @since 2.0.0
+   * @since 4.0.0
    */
   <V>(predicate: Predicate<V>) => (self: TxHashSet<V>) => Effect.Effect<boolean>,
   /**
@@ -1622,7 +1619,7 @@ export const every: {
    * ```
    *
    * @category elements
-   * @since 2.0.0
+   * @since 4.0.0
    */
   <V>(self: TxHashSet<V>, predicate: Predicate<V>) => Effect.Effect<boolean>
 >(2, <V>(self: TxHashSet<V>, predicate: Predicate<V>) =>
@@ -1656,7 +1653,7 @@ export const every: {
  * ```
  *
  * @category mapping
- * @since 2.0.0
+ * @since 4.0.0
  */
 export const map: {
   /**
@@ -1684,7 +1681,7 @@ export const map: {
    * ```
    *
    * @category mapping
-   * @since 2.0.0
+   * @since 4.0.0
    */
   <V, U>(f: (value: V) => U): (self: TxHashSet<V>) => Effect.Effect<TxHashSet<U>>
   /**
@@ -1712,7 +1709,7 @@ export const map: {
    * ```
    *
    * @category mapping
-   * @since 2.0.0
+   * @since 4.0.0
    */
   <V, U>(self: TxHashSet<V>, f: (value: V) => U): Effect.Effect<TxHashSet<U>>
 } = dual<
@@ -1741,7 +1738,7 @@ export const map: {
    * ```
    *
    * @category mapping
-   * @since 2.0.0
+   * @since 4.0.0
    */
   <V, U>(f: (value: V) => U) => (self: TxHashSet<V>) => Effect.Effect<TxHashSet<U>>,
   /**
@@ -1769,7 +1766,7 @@ export const map: {
    * ```
    *
    * @category mapping
-   * @since 2.0.0
+   * @since 4.0.0
    */
   <V, U>(self: TxHashSet<V>, f: (value: V) => U) => Effect.Effect<TxHashSet<U>>
 >(2, <V, U>(self: TxHashSet<V>, f: (value: V) => U) =>
@@ -1798,7 +1795,7 @@ export const map: {
  * ```
  *
  * @category filtering
- * @since 2.0.0
+ * @since 4.0.0
  */
 export const filter: {
   /**
@@ -1820,7 +1817,7 @@ export const filter: {
    * ```
    *
    * @category filtering
-   * @since 2.0.0
+   * @since 4.0.0
    */
   <V, U extends V>(refinement: Refinement<NoInfer<V>, U>): (self: TxHashSet<V>) => Effect.Effect<TxHashSet<U>>
   /**
@@ -1842,7 +1839,7 @@ export const filter: {
    * ```
    *
    * @category filtering
-   * @since 2.0.0
+   * @since 4.0.0
    */
   <V>(predicate: Predicate<NoInfer<V>>): (self: TxHashSet<V>) => Effect.Effect<TxHashSet<V>>
   /**
@@ -1864,7 +1861,7 @@ export const filter: {
    * ```
    *
    * @category filtering
-   * @since 2.0.0
+   * @since 4.0.0
    */
   <V, U extends V>(self: TxHashSet<V>, refinement: Refinement<V, U>): Effect.Effect<TxHashSet<U>>
   /**
@@ -1886,7 +1883,7 @@ export const filter: {
    * ```
    *
    * @category filtering
-   * @since 2.0.0
+   * @since 4.0.0
    */
   <V>(self: TxHashSet<V>, predicate: Predicate<V>): Effect.Effect<TxHashSet<V>>
 } = dual<
@@ -1909,7 +1906,7 @@ export const filter: {
    * ```
    *
    * @category filtering
-   * @since 2.0.0
+   * @since 4.0.0
    */
   {
     <V, U extends V>(
@@ -1938,7 +1935,7 @@ export const filter: {
    * ```
    *
    * @category filtering
-   * @since 2.0.0
+   * @since 4.0.0
    */
   {
     <V, U extends V>(
@@ -2087,8 +2084,7 @@ export const reduce: {
  * **Example** (Taking a HashSet snapshot)
  *
  * ```ts
- * import { Effect, TxHashSet } from "effect"
- * import * as HashSet from "effect/HashSet"
+ * import { Effect, HashSet, TxHashSet } from "effect"
  *
  * const program = Effect.gen(function*() {
  *   const txSet = yield* TxHashSet.make("x", "y", "z")
@@ -2104,7 +2100,7 @@ export const reduce: {
  * })
  * ```
  *
- * @category conversions
+ * @category converting
  * @since 2.0.0
  */
 export const toHashSet = <V>(self: TxHashSet<V>): Effect.Effect<HashSet.HashSet<V>> => TxRef.get(self.ref)

package/src/TxPriorityQueue.ts

@@ -109,7 +109,7 @@ const insertSorted = <A>(chunk: Chunk<A>, value: A, ord: Order<A>): Chunk<A> =>
  * ```
  *
  * @category constructors
- * @since 4.0.0
+ * @since 2.0.0
  */
 export const empty = <A>(order: Order<A>): Effect.Effect<TxPriorityQueue<A>> =>
   Effect.map(TxRef.make<Chunk<A>>(C.empty()), (ref) => makeTxPriorityQueue(ref, order))
@@ -130,7 +130,7 @@ export const empty = <A>(order: Order<A>): Effect.Effect<TxPriorityQueue<A>> =>
  * ```
  *
  * @category constructors
- * @since 4.0.0
+ * @since 2.0.0
  */
 export const fromIterable: {
   /**
@@ -149,7 +149,7 @@ export const fromIterable: {
    * ```
    *
    * @category constructors
-   * @since 4.0.0
+   * @since 2.0.0
    */
   <A>(order: Order<A>): (iterable: Iterable<A>) => Effect.Effect<TxPriorityQueue<A>>
   /**
@@ -168,7 +168,7 @@ export const fromIterable: {
    * ```
    *
    * @category constructors
-   * @since 4.0.0
+   * @since 2.0.0
    */
   <A>(order: Order<A>, iterable: Iterable<A>): Effect.Effect<TxPriorityQueue<A>>
 } = dual(
@@ -192,7 +192,7 @@ export const fromIterable: {
        * ```
        *
        * @category constructors
-       * @since 4.0.0
+       * @since 2.0.0
        */
       Chunk<A>>(C.fromIterable(arr)),
       (ref) => makeTxPriorityQueue(ref, order)
@@ -216,7 +216,7 @@ export const fromIterable: {
  * ```
  *
  * @category constructors
- * @since 4.0.0
+ * @since 2.0.0
  */
 export const make = <A>(order: Order<A>) => (...elements: Array<A>): Effect.Effect<TxPriorityQueue<A>> =>
   fromIterable(order, elements)
@@ -237,7 +237,7 @@ export const make = <A>(order: Order<A>) => (...elements: Array<A>): Effect.Effe
  * ```
  *
  * @category getters
- * @since 4.0.0
+ * @since 2.0.0
  */
 export const size = <A>(self: TxPriorityQueue<A>): Effect.Effect<number> => Effect.map(TxRef.get(self.ref), C.size)
 
@@ -257,7 +257,7 @@ export const size = <A>(self: TxPriorityQueue<A>): Effect.Effect<number> => Effe
  * ```
  *
  * @category getters
- * @since 4.0.0
+ * @since 2.0.0
  */
 export const isEmpty = <A>(self: TxPriorityQueue<A>): Effect.Effect<boolean> => Effect.map(size(self), (n) => n === 0)
 
@@ -277,7 +277,7 @@ export const isEmpty = <A>(self: TxPriorityQueue<A>): Effect.Effect<boolean> =>
  * ```
  *
  * @category getters
- * @since 4.0.0
+ * @since 2.0.0
  */
 export const isNonEmpty = <A>(self: TxPriorityQueue<A>): Effect.Effect<boolean> => Effect.map(size(self), (n) => n > 0)
 
@@ -298,7 +298,7 @@ export const isNonEmpty = <A>(self: TxPriorityQueue<A>): Effect.Effect<boolean>
  * ```
  *
  * @category getters
- * @since 4.0.0
+ * @since 2.0.0
  */
 export const peek = <A>(self: TxPriorityQueue<A>): Effect.Effect<A> =>
   Effect.gen(function*() {
@@ -327,7 +327,7 @@ export const peek = <A>(self: TxPriorityQueue<A>): Effect.Effect<A> =>
  * ```
  *
  * @category getters
- * @since 4.0.0
+ * @since 2.0.0
  */
 export const peekOption = <A>(self: TxPriorityQueue<A>): Effect.Effect<Option<A>> =>
   Effect.map(TxRef.get(self.ref), C.head)
@@ -350,7 +350,7 @@ export const peekOption = <A>(self: TxPriorityQueue<A>): Effect.Effect<Option<A>
  * ```
  *
  * @category mutations
- * @since 4.0.0
+ * @since 2.0.0
  */
 export const offer: {
   /**
@@ -371,7 +371,7 @@ export const offer: {
    * ```
    *
    * @category mutations
-   * @since 4.0.0
+   * @since 2.0.0
    */
   <A>(value: A): (self: TxPriorityQueue<A>) => Effect.Effect<void>
   /**
@@ -392,7 +392,7 @@ export const offer: {
    * ```
    *
    * @category mutations
-   * @since 4.0.0
+   * @since 2.0.0
    */
   <A>(self: TxPriorityQueue<A>, value: A): Effect.Effect<void>
 } = dual(
@@ -418,7 +418,7 @@ export const offer: {
  * ```
  *
  * @category mutations
- * @since 4.0.0
+ * @since 2.0.0
  */
 export const offerAll: {
   /**
@@ -438,7 +438,7 @@ export const offerAll: {
    * ```
    *
    * @category mutations
-   * @since 4.0.0
+   * @since 2.0.0
    */
   <A>(values: Iterable<A>): (self: TxPriorityQueue<A>) => Effect.Effect<void>
   /**
@@ -458,7 +458,7 @@ export const offerAll: {
    * ```
    *
    * @category mutations
-   * @since 4.0.0
+   * @since 2.0.0
    */
   <A>(self: TxPriorityQueue<A>, values: Iterable<A>): Effect.Effect<void>
 } = dual(
@@ -486,7 +486,7 @@ export const offerAll: {
  * ```
  *
  * @category mutations
- * @since 4.0.0
+ * @since 2.0.0
  */
 export const take = <A>(self: TxPriorityQueue<A>): Effect.Effect<A> =>
   Effect.gen(function*() {
@@ -515,7 +515,7 @@ export const take = <A>(self: TxPriorityQueue<A>): Effect.Effect<A> =>
  * ```
  *
  * @category mutations
- * @since 4.0.0
+ * @since 2.0.0
  */
 export const takeAll = <A>(self: TxPriorityQueue<A>): Effect.Effect<Array<A>> =>
   Effect.map(
@@ -539,7 +539,7 @@ export const takeAll = <A>(self: TxPriorityQueue<A>): Effect.Effect<Array<A>> =>
  * ```
  *
  * @category mutations
- * @since 4.0.0
+ * @since 2.0.0
  */
 export const takeOption = <A>(self: TxPriorityQueue<A>): Effect.Effect<Option<A>> =>
   TxRef.modify(self.ref, (chunk) => {
@@ -566,7 +566,7 @@ export const takeOption = <A>(self: TxPriorityQueue<A>): Effect.Effect<Option<A>
  * ```
  *
  * @category mutations
- * @since 4.0.0
+ * @since 2.0.0
  */
 export const takeUpTo: {
   /**
@@ -585,7 +585,7 @@ export const takeUpTo: {
    * ```
    *
    * @category mutations
-   * @since 4.0.0
+   * @since 2.0.0
    */
   (n: number): <A>(self: TxPriorityQueue<A>) => Effect.Effect<Array<A>>
   /**
@@ -604,7 +604,7 @@ export const takeUpTo: {
    * ```
    *
    * @category mutations
-   * @since 4.0.0
+   * @since 2.0.0
    */
   <A>(self: TxPriorityQueue<A>, n: number): Effect.Effect<Array<A>>
 } = dual(
@@ -637,7 +637,7 @@ export const takeUpTo: {
  * ```
  *
  * @category filtering
- * @since 4.0.0
+ * @since 2.0.0
  */
 export const removeIf: {
   /**
@@ -657,7 +657,7 @@ export const removeIf: {
    * ```
    *
    * @category filtering
-   * @since 4.0.0
+   * @since 2.0.0
    */
   <A>(predicate: Predicate<A>): (self: TxPriorityQueue<A>) => Effect.Effect<void>
   /**
@@ -677,7 +677,7 @@ export const removeIf: {
    * ```
    *
    * @category filtering
-   * @since 4.0.0
+   * @since 2.0.0
    */
   <A>(self: TxPriorityQueue<A>, predicate: Predicate<A>): Effect.Effect<void>
 } = dual(
@@ -703,7 +703,7 @@ export const removeIf: {
  * ```
  *
  * @category filtering
- * @since 4.0.0
+ * @since 2.0.0
  */
 export const retainIf: {
   /**
@@ -723,7 +723,7 @@ export const retainIf: {
    * ```
    *
    * @category filtering
-   * @since 4.0.0
+   * @since 2.0.0
    */
   <A>(predicate: Predicate<A>): (self: TxPriorityQueue<A>) => Effect.Effect<void>
   /**
@@ -743,7 +743,7 @@ export const retainIf: {
    * ```
    *
    * @category filtering
-   * @since 4.0.0
+   * @since 2.0.0
    */
   <A>(self: TxPriorityQueue<A>, predicate: Predicate<A>): Effect.Effect<void>
 } = dual(
@@ -767,8 +767,8 @@ export const retainIf: {
  * })
  * ```
  *
- * @category conversions
- * @since 4.0.0
+ * @category converting
+ * @since 2.0.0
  */
 export const toArray = <A>(self: TxPriorityQueue<A>): Effect.Effect<Array<A>> =>
   Effect.map(TxRef.get(self.ref), C.toArray)