effect 3.8.3 → 3.8.5

package/src/MutableHashMap.ts

@@ -140,10 +140,26 @@ export const fromIterable = <K, V>(entries: Iterable<readonly [K, V]>): MutableH
  * @category elements
  */
 export const get: {
+  /**
+   * @since 2.0.0
+   * @category elements
+   */
   <K>(key: K): <V>(self: MutableHashMap<K, V>) => Option.Option<V>
+  /**
+   * @since 2.0.0
+   * @category elements
+   */
   <K, V>(self: MutableHashMap<K, V>, key: K): Option.Option<V>
 } = dual<
+  /**
+   * @since 2.0.0
+   * @category elements
+   */
   <K>(key: K) => <V>(self: MutableHashMap<K, V>) => Option.Option<V>,
+  /**
+   * @since 2.0.0
+   * @category elements
+   */
   <K, V>(self: MutableHashMap<K, V>, key: K) => Option.Option<V>
 >(2, <K, V>(self: MutableHashMap<K, V>, key: K): Option.Option<V> => {
   if (Equal.isEqual(key) === false) {
@@ -196,10 +212,26 @@ const getFromBucket = <K, V>(
  * @category elements
  */
 export const has: {
+  /**
+   * @since 2.0.0
+   * @category elements
+   */
   <K>(key: K): <V>(self: MutableHashMap<K, V>) => boolean
+  /**
+   * @since 2.0.0
+   * @category elements
+   */
   <K, V>(self: MutableHashMap<K, V>, key: K): boolean
 } = dual<
+  /**
+   * @since 2.0.0
+   * @category elements
+   */
   <K>(key: K) => <V>(self: MutableHashMap<K, V>) => boolean,
+  /**
+   * @since 2.0.0
+   * @category elements
+   */
   <K, V>(self: MutableHashMap<K, V>, key: K) => boolean
 >(2, (self, key) => Option.isSome(get(self, key)))
 
@@ -207,10 +239,22 @@ export const has: {
  * @since 2.0.0
  */
 export const set: {
+  /**
+   * @since 2.0.0
+   */
   <K, V>(key: K, value: V): (self: MutableHashMap<K, V>) => MutableHashMap<K, V>
+  /**
+   * @since 2.0.0
+   */
   <K, V>(self: MutableHashMap<K, V>, key: K, value: V): MutableHashMap<K, V>
 } = dual<
+  /**
+   * @since 2.0.0
+   */
   <K, V>(key: K, value: V) => (self: MutableHashMap<K, V>) => MutableHashMap<K, V>,
+  /**
+   * @since 2.0.0
+   */
   <K, V>(self: MutableHashMap<K, V>, key: K, value: V) => MutableHashMap<K, V>
 >(3, <K, V>(self: MutableHashMap<K, V>, key: K, value: V) => {
   if (Equal.isEqual(key) === false) {
@@ -252,10 +296,30 @@ const removeFromBucket = <K, V>(
  * @since 2.0.0
  */
 export const modify: {
+  /**
+   * Updates the value of the specified key within the `MutableHashMap` if it exists.
+   *
+   * @since 2.0.0
+   */
   <K, V>(key: K, f: (v: V) => V): (self: MutableHashMap<K, V>) => MutableHashMap<K, V>
+  /**
+   * Updates the value of the specified key within the `MutableHashMap` if it exists.
+   *
+   * @since 2.0.0
+   */
   <K, V>(self: MutableHashMap<K, V>, key: K, f: (v: V) => V): MutableHashMap<K, V>
 } = dual<
+  /**
+   * Updates the value of the specified key within the `MutableHashMap` if it exists.
+   *
+   * @since 2.0.0
+   */
   <K, V>(key: K, f: (v: V) => V) => (self: MutableHashMap<K, V>) => MutableHashMap<K, V>,
+  /**
+   * Updates the value of the specified key within the `MutableHashMap` if it exists.
+   *
+   * @since 2.0.0
+   */
   <K, V>(self: MutableHashMap<K, V>, key: K, f: (v: V) => V) => MutableHashMap<K, V>
 >(3, <K, V>(self: MutableHashMap<K, V>, key: K, f: (v: V) => V) => {
   if (Equal.isEqual(key) === false) {
@@ -287,13 +351,41 @@ export const modify: {
  * @since 2.0.0
  */
 export const modifyAt: {
+  /**
+   * Set or remove the specified key in the `MutableHashMap` using the specified
+   * update function.
+   *
+   * @since 2.0.0
+   */
   <K, V>(key: K, f: (value: Option.Option<V>) => Option.Option<V>): (self: MutableHashMap<K, V>) => MutableHashMap<K, V>
-  <K, V>(self: MutableHashMap<K, V>, key: K, f: (value: Option.Option<V>) => Option.Option<V>): MutableHashMap<K, V>
+  /**
+   * Set or remove the specified key in the `MutableHashMap` using the specified
+   * update function.
+   *
+   * @since 2.0.0
+   */
+  <K, V>(
+    self: MutableHashMap<K, V>,
+    key: K,
+    f: (value: Option.Option<V>) => Option.Option<V>
+  ): MutableHashMap<K, V>
 } = dual<
+  /**
+   * Set or remove the specified key in the `MutableHashMap` using the specified
+   * update function.
+   *
+   * @since 2.0.0
+   */
   <K, V>(
     key: K,
     f: (value: Option.Option<V>) => Option.Option<V>
   ) => (self: MutableHashMap<K, V>) => MutableHashMap<K, V>,
+  /**
+   * Set or remove the specified key in the `MutableHashMap` using the specified
+   * update function.
+   *
+   * @since 2.0.0
+   */
   <K, V>(
     self: MutableHashMap<K, V>,
     key: K,
@@ -333,10 +425,22 @@ export const modifyAt: {
  * @since 2.0.0
  */
 export const remove: {
+  /**
+   * @since 2.0.0
+   */
   <K>(key: K): <V>(self: MutableHashMap<K, V>) => MutableHashMap<K, V>
+  /**
+   * @since 2.0.0
+   */
   <K, V>(self: MutableHashMap<K, V>, key: K): MutableHashMap<K, V>
 } = dual<
+  /**
+   * @since 2.0.0
+   */
   <K>(key: K) => <V>(self: MutableHashMap<K, V>) => MutableHashMap<K, V>,
+  /**
+   * @since 2.0.0
+   */
   <K, V>(self: MutableHashMap<K, V>, key: K) => MutableHashMap<K, V>
 >(2, <K, V>(self: MutableHashMap<K, V>, key: K) => {
   if (Equal.isEqual(key) === false) {

package/src/MutableHashSet.ts

@@ -82,7 +82,15 @@ export const make = <Keys extends ReadonlyArray<unknown>>(
  * @category elements
  */
 export const add: {
+  /**
+   * @since 2.0.0
+   * @category elements
+   */
   <V>(key: V): (self: MutableHashSet<V>) => MutableHashSet<V>
+  /**
+   * @since 2.0.0
+   * @category elements
+   */
   <V>(self: MutableHashSet<V>, key: V): MutableHashSet<V>
 } = Dual.dual<
   <V>(key: V) => (self: MutableHashSet<V>) => MutableHashSet<V>,
@@ -94,7 +102,15 @@ export const add: {
  * @category elements
  */
 export const has: {
+  /**
+   * @since 2.0.0
+   * @category elements
+   */
   <V>(key: V): (self: MutableHashSet<V>) => boolean
+  /**
+   * @since 2.0.0
+   * @category elements
+   */
   <V>(self: MutableHashSet<V>, key: V): boolean
 } = Dual.dual<
   <V>(key: V) => (self: MutableHashSet<V>) => boolean,
@@ -106,7 +122,15 @@ export const has: {
  * @category elements
  */
 export const remove: {
+  /**
+   * @since 2.0.0
+   * @category elements
+   */
   <V>(key: V): (self: MutableHashSet<V>) => MutableHashSet<V>
+  /**
+   * @since 2.0.0
+   * @category elements
+   */
   <V>(self: MutableHashSet<V>, key: V): MutableHashSet<V>
 } = Dual.dual<
   <V>(key: V) => (self: MutableHashSet<V>) => MutableHashSet<V>,

package/src/MutableList.ts

@@ -166,7 +166,19 @@ export const head = <A>(self: MutableList<A>): A | undefined => self.head === un
  * @category traversing
  */
 export const forEach: {
+  /**
+   * Executes the specified function `f` for each element in the list.
+   *
+   * @since 2.0.0
+   * @category traversing
+   */
   <A>(f: (element: A) => void): (self: MutableList<A>) => void
+  /**
+   * Executes the specified function `f` for each element in the list.
+   *
+   * @since 2.0.0
+   * @category traversing
+   */
   <A>(self: MutableList<A>, f: (element: A) => void): void
 } = Dual.dual<
   <A>(f: (element: A) => void) => (self: MutableList<A>) => void,
@@ -198,7 +210,19 @@ export const reset = <A>(self: MutableList<A>): MutableList<A> => {
  * @since 2.0.0
  */
 export const append: {
+  /**
+   * Appends the specified element to the end of the `MutableList`.
+   *
+   * @category concatenating
+   * @since 2.0.0
+   */
   <A>(value: A): (self: MutableList<A>) => MutableList<A>
+  /**
+   * Appends the specified element to the end of the `MutableList`.
+   *
+   * @category concatenating
+   * @since 2.0.0
+   */
   <A>(self: MutableList<A>, value: A): MutableList<A>
 } = Dual.dual<
   <A>(value: A) => (self: MutableList<A>) => MutableList<A>,
@@ -254,7 +278,19 @@ export const pop = <A>(self: MutableList<A>): A | undefined => {
  * @since 2.0.0
  */
 export const prepend: {
+  /**
+   * Prepends the specified value to the beginning of the list.
+   *
+   * @category concatenating
+   * @since 2.0.0
+   */
   <A>(value: A): (self: MutableList<A>) => MutableList<A>
+  /**
+   * Prepends the specified value to the beginning of the list.
+   *
+   * @category concatenating
+   * @since 2.0.0
+   */
   <A>(self: MutableList<A>, value: A): MutableList<A>
 } = Dual.dual<
   <A>(value: A) => (self: MutableList<A>) => MutableList<A>,

package/src/MutableQueue.ts

@@ -134,7 +134,21 @@ export const capacity = <A>(self: MutableQueue<A>): number => self.capacity ===
  * @since 2.0.0
  */
 export const offer: {
+  /**
+   * Offers an element to the queue.
+   *
+   * Returns whether the enqueue was successful or not.
+   *
+   * @since 2.0.0
+   */
   <A>(self: MutableQueue<A>, value: A): boolean
+  /**
+   * Offers an element to the queue.
+   *
+   * Returns whether the enqueue was successful or not.
+   *
+   * @since 2.0.0
+   */
   <A>(value: A): (self: MutableQueue<A>) => boolean
 } = Dual.dual<
   <A>(value: A) => (self: MutableQueue<A>) => boolean,
@@ -156,7 +170,21 @@ export const offer: {
  * @since 2.0.0
  */
 export const offerAll: {
+  /**
+   * Enqueues a collection of values into the queue.
+   *
+   * Returns a `Chunk` of the values that were **not** able to be enqueued.
+   *
+   * @since 2.0.0
+   */
   <A>(values: Iterable<A>): (self: MutableQueue<A>) => Chunk.Chunk<A>
+  /**
+   * Enqueues a collection of values into the queue.
+   *
+   * Returns a `Chunk` of the values that were **not** able to be enqueued.
+   *
+   * @since 2.0.0
+   */
   <A>(self: MutableQueue<A>, values: Iterable<A>): Chunk.Chunk<A>
 } = Dual.dual<
   <A>(values: Iterable<A>) => (self: MutableQueue<A>) => Chunk.Chunk<A>,
@@ -187,7 +215,27 @@ export const offerAll: {
  * @since 2.0.0
  */
 export const poll: {
+  /**
+   * Dequeues an element from the queue.
+   *
+   * Returns either an element from the queue, or the `def` param.
+   *
+   * **Note**: if there is no meaningful default for your type, you can always
+   * use `poll(MutableQueue.EmptyMutableQueue)`.
+   *
+   * @since 2.0.0
+   */
   <D>(def: D): <A>(self: MutableQueue<A>) => D | A
+  /**
+   * Dequeues an element from the queue.
+   *
+   * Returns either an element from the queue, or the `def` param.
+   *
+   * **Note**: if there is no meaningful default for your type, you can always
+   * use `poll(MutableQueue.EmptyMutableQueue)`.
+   *
+   * @since 2.0.0
+   */
   <A, D>(self: MutableQueue<A>, def: D): A | D
 } = Dual.dual<
   <D>(def: D) => <A>(self: MutableQueue<A>) => A | D,
@@ -207,7 +255,21 @@ export const poll: {
  * @since 2.0.0
  */
 export const pollUpTo: {
+  /**
+   * Dequeues up to `n` elements from the queue.
+   *
+   * Returns a `List` of up to `n` elements.
+   *
+   * @since 2.0.0
+   */
   (n: number): <A>(self: MutableQueue<A>) => Chunk.Chunk<A>
+  /**
+   * Dequeues up to `n` elements from the queue.
+   *
+   * Returns a `List` of up to `n` elements.
+   *
+   * @since 2.0.0
+   */
   <A>(self: MutableQueue<A>, n: number): Chunk.Chunk<A>
 } = Dual.dual<
   (n: number) => <A>(self: MutableQueue<A>) => Chunk.Chunk<A>,

package/src/MutableRef.ts

@@ -60,7 +60,15 @@ export const make = <T>(value: T): MutableRef<T> => {
  * @category general
  */
 export const compareAndSet: {
+  /**
+   * @since 2.0.0
+   * @category general
+   */
   <T>(oldValue: T, newValue: T): (self: MutableRef<T>) => boolean
+  /**
+   * @since 2.0.0
+   * @category general
+   */
   <T>(self: MutableRef<T>, oldValue: T, newValue: T): boolean
 } = Dual.dual<
   <T>(oldValue: T, newValue: T) => (self: MutableRef<T>) => boolean,
@@ -108,7 +116,15 @@ export const getAndIncrement = (self: MutableRef<number>): number => getAndUpdat
  * @category general
  */
 export const getAndSet: {
+  /**
+   * @since 2.0.0
+   * @category general
+   */
   <T>(value: T): (self: MutableRef<T>) => T
+  /**
+   * @since 2.0.0
+   * @category general
+   */
   <T>(self: MutableRef<T>, value: T): T
 } = Dual.dual<
   <T>(value: T) => (self: MutableRef<T>) => T,
@@ -124,7 +140,15 @@ export const getAndSet: {
  * @category general
  */
 export const getAndUpdate: {
+  /**
+   * @since 2.0.0
+   * @category general
+   */
   <T>(f: (value: T) => T): (self: MutableRef<T>) => T
+  /**
+   * @since 2.0.0
+   * @category general
+   */
   <T>(self: MutableRef<T>, f: (value: T) => T): T
 } = Dual.dual<
   <T>(f: (value: T) => T) => (self: MutableRef<T>) => T,
@@ -148,7 +172,15 @@ export const incrementAndGet = (self: MutableRef<number>): number => updateAndGe
  * @category general
  */
 export const set: {
+  /**
+   * @since 2.0.0
+   * @category general
+   */
   <T>(value: T): (self: MutableRef<T>) => MutableRef<T>
+  /**
+   * @since 2.0.0
+   * @category general
+   */
   <T>(self: MutableRef<T>, value: T): MutableRef<T>
 } = Dual.dual<
   <T>(value: T) => (self: MutableRef<T>) => MutableRef<T>,
@@ -163,7 +195,15 @@ export const set: {
  * @category general
  */
 export const setAndGet: {
+  /**
+   * @since 2.0.0
+   * @category general
+   */
   <T>(value: T): (self: MutableRef<T>) => T
+  /**
+   * @since 2.0.0
+   * @category general
+   */
   <T>(self: MutableRef<T>, value: T): T
 } = Dual.dual<
   <T>(value: T) => (self: MutableRef<T>) => T,
@@ -178,7 +218,15 @@ export const setAndGet: {
  * @category general
  */
 export const update: {
+  /**
+   * @since 2.0.0
+   * @category general
+   */
   <T>(f: (value: T) => T): (self: MutableRef<T>) => MutableRef<T>
+  /**
+   * @since 2.0.0
+   * @category general
+   */
   <T>(self: MutableRef<T>, f: (value: T) => T): MutableRef<T>
 } = Dual.dual<
   <T>(f: (value: T) => T) => (self: MutableRef<T>) => MutableRef<T>,
@@ -190,7 +238,15 @@ export const update: {
  * @category general
  */
 export const updateAndGet: {
+  /**
+   * @since 2.0.0
+   * @category general
+   */
   <T>(f: (value: T) => T): (self: MutableRef<T>) => T
+  /**
+   * @since 2.0.0
+   * @category general
+   */
   <T>(self: MutableRef<T>, f: (value: T) => T): T
 } = Dual.dual<
   <T>(f: (value: T) => T) => (self: MutableRef<T>) => T,