effect 3.8.4 → 3.8.5

package/src/FiberRef.ts

@@ -179,7 +179,15 @@ export const get: <A>(self: FiberRef<A>) => Effect.Effect<A> = core.fiberRefGet
  * @category utils
  */
 export const getAndSet: {
+  /**
+   * @since 2.0.0
+   * @category utils
+   */
   <A>(value: A): (self: FiberRef<A>) => Effect.Effect<A>
+  /**
+   * @since 2.0.0
+   * @category utils
+   */
   <A>(self: FiberRef<A>, value: A): Effect.Effect<A>
 } = core.fiberRefGetAndSet
 
@@ -188,7 +196,15 @@ export const getAndSet: {
  * @category utils
  */
 export const getAndUpdate: {
+  /**
+   * @since 2.0.0
+   * @category utils
+   */
   <A>(f: (a: A) => A): (self: FiberRef<A>) => Effect.Effect<A>
+  /**
+   * @since 2.0.0
+   * @category utils
+   */
   <A>(self: FiberRef<A>, f: (a: A) => A): Effect.Effect<A>
 } = core.fiberRefGetAndUpdate
 
@@ -197,7 +213,15 @@ export const getAndUpdate: {
  * @category utils
  */
 export const getAndUpdateSome: {
+  /**
+   * @since 2.0.0
+   * @category utils
+   */
   <A>(pf: (a: A) => Option.Option<A>): (self: FiberRef<A>) => Effect.Effect<A>
+  /**
+   * @since 2.0.0
+   * @category utils
+   */
   <A>(self: FiberRef<A>, pf: (a: A) => Option.Option<A>): Effect.Effect<A>
 } = core.fiberRefGetAndUpdateSome
 
@@ -206,7 +230,15 @@ export const getAndUpdateSome: {
  * @category utils
  */
 export const getWith: {
+  /**
+   * @since 2.0.0
+   * @category utils
+   */
   <A, B, E, R>(f: (a: A) => Effect.Effect<B, E, R>): (self: FiberRef<A>) => Effect.Effect<B, E, R>
+  /**
+   * @since 2.0.0
+   * @category utils
+   */
   <A, B, E, R>(self: FiberRef<A>, f: (a: A) => Effect.Effect<B, E, R>): Effect.Effect<B, E, R>
 } = core.fiberRefGetWith
 
@@ -215,7 +247,15 @@ export const getWith: {
  * @category utils
  */
 export const set: {
+  /**
+   * @since 2.0.0
+   * @category utils
+   */
   <A>(value: A): (self: FiberRef<A>) => Effect.Effect<void>
+  /**
+   * @since 2.0.0
+   * @category utils
+   */
   <A>(self: FiberRef<A>, value: A): Effect.Effect<void>
 } = core.fiberRefSet
 
@@ -240,7 +280,15 @@ export const reset: <A>(self: FiberRef<A>) => Effect.Effect<void> = core.fiberRe
  * @category utils
  */
 export const modify: {
+  /**
+   * @since 2.0.0
+   * @category utils
+   */
   <A, B>(f: (a: A) => readonly [B, A]): (self: FiberRef<A>) => Effect.Effect<B>
+  /**
+   * @since 2.0.0
+   * @category utils
+   */
   <A, B>(self: FiberRef<A>, f: (a: A) => readonly [B, A]): Effect.Effect<B>
 } = core.fiberRefModify
 
@@ -259,7 +307,15 @@ export const modifySome: <A, B>(
  * @category utils
  */
 export const update: {
+  /**
+   * @since 2.0.0
+   * @category utils
+   */
   <A>(f: (a: A) => A): (self: FiberRef<A>) => Effect.Effect<void>
+  /**
+   * @since 2.0.0
+   * @category utils
+   */
   <A>(self: FiberRef<A>, f: (a: A) => A): Effect.Effect<void>
 } = core.fiberRefUpdate
 
@@ -268,7 +324,15 @@ export const update: {
  * @category utils
  */
 export const updateSome: {
+  /**
+   * @since 2.0.0
+   * @category utils
+   */
   <A>(pf: (a: A) => Option.Option<A>): (self: FiberRef<A>) => Effect.Effect<void>
+  /**
+   * @since 2.0.0
+   * @category utils
+   */
   <A>(self: FiberRef<A>, pf: (a: A) => Option.Option<A>): Effect.Effect<void>
 } = core.fiberRefUpdateSome
 
@@ -277,7 +341,15 @@ export const updateSome: {
  * @category utils
  */
 export const updateAndGet: {
+  /**
+   * @since 2.0.0
+   * @category utils
+   */
   <A>(f: (a: A) => A): (self: FiberRef<A>) => Effect.Effect<A>
+  /**
+   * @since 2.0.0
+   * @category utils
+   */
   <A>(self: FiberRef<A>, f: (a: A) => A): Effect.Effect<A>
 } = core.fiberRefUpdateAndGet
 
@@ -286,7 +358,15 @@ export const updateAndGet: {
  * @category utils
  */
 export const updateSomeAndGet: {
+  /**
+   * @since 2.0.0
+   * @category utils
+   */
   <A>(pf: (a: A) => Option.Option<A>): (self: FiberRef<A>) => Effect.Effect<A>
+  /**
+   * @since 2.0.0
+   * @category utils
+   */
   <A>(self: FiberRef<A>, pf: (a: A) => Option.Option<A>): Effect.Effect<A>
 } = core.fiberRefUpdateSomeAndGet
 

package/src/FiberRefs.ts

@@ -68,7 +68,23 @@ export const fiberRefs: (self: FiberRefs) => HashSet.HashSet<FiberRef.FiberRef<a
  * @category utils
  */
 export const forkAs: {
+  /**
+   * Forks this collection of fiber refs as the specified child fiber id. This
+   * will potentially modify the value of the fiber refs, as determined by the
+   * individual fiber refs that make up the collection.
+   *
+   * @since 2.0.0
+   * @category utils
+   */
   (childId: FiberId.Single): (self: FiberRefs) => FiberRefs
+  /**
+   * Forks this collection of fiber refs as the specified child fiber id. This
+   * will potentially modify the value of the fiber refs, as determined by the
+   * individual fiber refs that make up the collection.
+   *
+   * @since 2.0.0
+   * @category utils
+   */
   (self: FiberRefs, childId: FiberId.Single): FiberRefs
 } = internal.forkAs
 
@@ -80,7 +96,21 @@ export const forkAs: {
  * @category getters
  */
 export const get: {
+  /**
+   * Gets the value of the specified `FiberRef` in this collection of `FiberRef`
+   * values if it exists or `None` otherwise.
+   *
+   * @since 2.0.0
+   * @category getters
+   */
   <A>(fiberRef: FiberRef.FiberRef<A>): (self: FiberRefs) => Option.Option<A>
+  /**
+   * Gets the value of the specified `FiberRef` in this collection of `FiberRef`
+   * values if it exists or `None` otherwise.
+   *
+   * @since 2.0.0
+   * @category getters
+   */
   <A>(self: FiberRefs, fiberRef: FiberRef.FiberRef<A>): Option.Option<A>
 } = internal.get
 
@@ -92,7 +122,21 @@ export const get: {
  * @category getters
  */
 export const getOrDefault: {
+  /**
+   * Gets the value of the specified `FiberRef` in this collection of `FiberRef`
+   * values if it exists or the `initial` value of the `FiberRef` otherwise.
+   *
+   * @since 2.0.0
+   * @category getters
+   */
   <A>(fiberRef: FiberRef.FiberRef<A>): (self: FiberRefs) => A
+  /**
+   * Gets the value of the specified `FiberRef` in this collection of `FiberRef`
+   * values if it exists or the `initial` value of the `FiberRef` otherwise.
+   *
+   * @since 2.0.0
+   * @category getters
+   */
   <A>(self: FiberRefs, fiberRef: FiberRef.FiberRef<A>): A
 } = internal.getOrDefault
 
@@ -105,7 +149,23 @@ export const getOrDefault: {
  * @category utils
  */
 export const joinAs: {
+  /**
+   * Joins this collection of fiber refs to the specified collection, as the
+   * specified fiber id. This will perform diffing and merging to ensure
+   * preservation of maximum information from both child and parent refs.
+   *
+   * @since 2.0.0
+   * @category utils
+   */
   (fiberId: FiberId.Single, that: FiberRefs): (self: FiberRefs) => FiberRefs
+  /**
+   * Joins this collection of fiber refs to the specified collection, as the
+   * specified fiber id. This will perform diffing and merging to ensure
+   * preservation of maximum information from both child and parent refs.
+   *
+   * @since 2.0.0
+   * @category utils
+   */
   (self: FiberRefs, fiberId: FiberId.Single, that: FiberRefs): FiberRefs
 } = internal.joinAs
 
@@ -124,6 +184,12 @@ export const setAll: (self: FiberRefs) => Effect.Effect<void> = internal.setAll
  * @category utils
  */
 export const updateAs: {
+  /**
+   * Updates the value of the specified `FiberRef` using the provided `FiberId`
+   *
+   * @since 2.0.0
+   * @category utils
+   */
   <A>(
     options: {
       readonly fiberId: FiberId.Single
@@ -131,6 +197,12 @@ export const updateAs: {
       readonly value: A
     }
   ): (self: FiberRefs) => FiberRefs
+  /**
+   * Updates the value of the specified `FiberRef` using the provided `FiberId`
+   *
+   * @since 2.0.0
+   * @category utils
+   */
   <A>(
     self: FiberRefs,
     options: {
@@ -148,6 +220,12 @@ export const updateAs: {
  * @category utils
  */
 export const updateManyAs: {
+  /**
+   * Updates the values of the specified `FiberRef` & value pairs using the provided `FiberId`
+   *
+   * @since 2.0.0
+   * @category utils
+   */
   (
     options: {
       readonly forkAs?: FiberId.Single | undefined
@@ -165,6 +243,12 @@ export const updateManyAs: {
       ]
     }
   ): (self: FiberRefs) => FiberRefs
+  /**
+   * Updates the values of the specified `FiberRef` & value pairs using the provided `FiberId`
+   *
+   * @since 2.0.0
+   * @category utils
+   */
   (
     self: FiberRefs,
     options: {

package/src/FiberRefsPatch.ts

@@ -88,7 +88,23 @@ export const diff: (oldValue: FiberRefs.FiberRefs, newValue: FiberRefs.FiberRefs
  * @category constructors
  */
 export const combine: {
+  /**
+   * Combines this patch and the specified patch to create a new patch that
+   * describes applying the changes from this patch and the specified patch
+   * sequentially.
+   *
+   * @since 2.0.0
+   * @category constructors
+   */
   (that: FiberRefsPatch): (self: FiberRefsPatch) => FiberRefsPatch
+  /**
+   * Combines this patch and the specified patch to create a new patch that
+   * describes applying the changes from this patch and the specified patch
+   * sequentially.
+   *
+   * @since 2.0.0
+   * @category constructors
+   */
   (self: FiberRefsPatch, that: FiberRefsPatch): FiberRefsPatch
 } = internal.combine
 
@@ -100,6 +116,24 @@ export const combine: {
  * @category destructors
  */
 export const patch: {
+  /**
+   * Applies the changes described by this patch to the specified collection
+   * of `FiberRef` values.
+   *
+   * @since 2.0.0
+   * @category destructors
+   */
   (fiberId: FiberId.Runtime, oldValue: FiberRefs.FiberRefs): (self: FiberRefsPatch) => FiberRefs.FiberRefs
-  (self: FiberRefsPatch, fiberId: FiberId.Runtime, oldValue: FiberRefs.FiberRefs): FiberRefs.FiberRefs
+  /**
+   * Applies the changes described by this patch to the specified collection
+   * of `FiberRef` values.
+   *
+   * @since 2.0.0
+   * @category destructors
+   */
+  (
+    self: FiberRefsPatch,
+    fiberId: FiberId.Runtime,
+    oldValue: FiberRefs.FiberRefs
+  ): FiberRefs.FiberRefs
 } = internal.patch

package/src/FiberSet.ts

@@ -165,6 +165,12 @@ const isInternalInterruption = Cause.reduceWithContext(undefined, {
  * @categories combinators
  */
 export const unsafeAdd: {
+  /**
+   * Add a fiber to the FiberSet. When the fiber completes, it will be removed.
+   *
+   * @since 2.0.0
+   * @categories combinators
+   */
   <A, E, XE extends E, XA extends A>(
     fiber: Fiber.RuntimeFiber<XA, XE>,
     options?: {
@@ -172,6 +178,12 @@ export const unsafeAdd: {
       readonly propagateInterruption?: boolean | undefined
     } | undefined
   ): (self: FiberSet<A, E>) => void
+  /**
+   * Add a fiber to the FiberSet. When the fiber completes, it will be removed.
+   *
+   * @since 2.0.0
+   * @categories combinators
+   */
   <A, E, XE extends E, XA extends A>(
     self: FiberSet<A, E>,
     fiber: Fiber.RuntimeFiber<XA, XE>,
@@ -221,12 +233,24 @@ export const unsafeAdd: {
  * @categories combinators
  */
 export const add: {
+  /**
+   * Add a fiber to the FiberSet. When the fiber completes, it will be removed.
+   *
+   * @since 2.0.0
+   * @categories combinators
+   */
   <A, E, XE extends E, XA extends A>(
     fiber: Fiber.RuntimeFiber<XA, XE>,
     options?: {
       readonly propagateInterruption?: boolean | undefined
     } | undefined
   ): (self: FiberSet<A, E>) => Effect.Effect<void>
+  /**
+   * Add a fiber to the FiberSet. When the fiber completes, it will be removed.
+   *
+   * @since 2.0.0
+   * @categories combinators
+   */
   <A, E, XE extends E, XA extends A>(
     self: FiberSet<A, E>,
     fiber: Fiber.RuntimeFiber<XA, XE>,
@@ -275,6 +299,13 @@ export const clear = <A, E>(self: FiberSet<A, E>): Effect.Effect<void> =>
  * @categories combinators
  */
 export const run: {
+  /**
+   * Fork an Effect and add the forked fiber to the FiberSet.
+   * When the fiber completes, it will be removed from the FiberSet.
+   *
+   * @since 2.0.0
+   * @categories combinators
+   */
   <A, E>(
     self: FiberSet<A, E>,
     options?: {
@@ -283,6 +314,13 @@ export const run: {
   ): <R, XE extends E, XA extends A>(
     effect: Effect.Effect<XA, XE, R>
   ) => Effect.Effect<Fiber.RuntimeFiber<XA, XE>, never, R>
+  /**
+   * Fork an Effect and add the forked fiber to the FiberSet.
+   * When the fiber completes, it will be removed from the FiberSet.
+   *
+   * @since 2.0.0
+   * @categories combinators
+   */
   <A, E, R, XE extends E, XA extends A>(
     self: FiberSet<A, E>,
     effect: Effect.Effect<XA, XE, R>,