effect 3.8.4 → 3.8.5

package/src/Fiber.ts

@@ -467,7 +467,23 @@ export const interrupted: (fiberId: FiberId.FiberId) => Fiber<never> = internal.
  * @category interruption
  */
 export const interruptAs: {
+  /**
+   * Interrupts the fiber as if interrupted from the specified fiber. If the
+   * fiber has already exited, the returned effect will resume immediately.
+   * Otherwise, the effect will resume when the fiber exits.
+   *
+   * @since 2.0.0
+   * @category interruption
+   */
   (fiberId: FiberId.FiberId): <A, E>(self: Fiber<A, E>) => Effect.Effect<Exit.Exit<A, E>>
+  /**
+   * Interrupts the fiber as if interrupted from the specified fiber. If the
+   * fiber has already exited, the returned effect will resume immediately.
+   * Otherwise, the effect will resume when the fiber exits.
+   *
+   * @since 2.0.0
+   * @category interruption
+   */
   <A, E>(self: Fiber<A, E>, fiberId: FiberId.FiberId): Effect.Effect<Exit.Exit<A, E>>
 } = core.interruptAsFiber
 
@@ -480,7 +496,23 @@ export const interruptAs: {
  * @category interruption
  */
 export const interruptAsFork: {
+  /**
+   * Interrupts the fiber as if interrupted from the specified fiber. If the
+   * fiber has already exited, the returned effect will resume immediately.
+   * Otherwise, the effect will resume when the fiber exits.
+   *
+   * @since 2.0.0
+   * @category interruption
+   */
   (fiberId: FiberId.FiberId): <A, E>(self: Fiber<A, E>) => Effect.Effect<void>
+  /**
+   * Interrupts the fiber as if interrupted from the specified fiber. If the
+   * fiber has already exited, the returned effect will resume immediately.
+   * Otherwise, the effect will resume when the fiber exits.
+   *
+   * @since 2.0.0
+   * @category interruption
+   */
   <A, E>(self: Fiber<A, E>, fiberId: FiberId.FiberId): Effect.Effect<void>
 } = internal.interruptAsFork
 
@@ -500,7 +532,21 @@ export const interruptAll: (fibers: Iterable<Fiber<any, any>>) => Effect.Effect<
  * @category interruption
  */
 export const interruptAllAs: {
+  /**
+   * Interrupts all fibers as by the specified fiber, awaiting their
+   * interruption.
+   *
+   * @since 2.0.0
+   * @category interruption
+   */
   (fiberId: FiberId.FiberId): (fibers: Iterable<Fiber<any, any>>) => Effect.Effect<void>
+  /**
+   * Interrupts all fibers as by the specified fiber, awaiting their
+   * interruption.
+   *
+   * @since 2.0.0
+   * @category interruption
+   */
   (fibers: Iterable<Fiber<any, any>>, fiberId: FiberId.FiberId): Effect.Effect<void>
 } = internal.interruptAllAs
 
@@ -543,7 +589,19 @@ export const joinAll: <A, E>(fibers: Iterable<Fiber<A, E>>) => Effect.Effect<Arr
  * @category mapping
  */
 export const map: {
+  /**
+   * Maps over the value the Fiber computes.
+   *
+   * @since 2.0.0
+   * @category mapping
+   */
   <A, B>(f: (a: A) => B): <E>(self: Fiber<A, E>) => Fiber<B, E>
+  /**
+   * Maps over the value the Fiber computes.
+   *
+   * @since 2.0.0
+   * @category mapping
+   */
   <A, E, B>(self: Fiber<A, E>, f: (a: A) => B): Fiber<B, E>
 } = internal.map
 
@@ -554,7 +612,19 @@ export const map: {
  * @category mapping
  */
 export const mapEffect: {
+  /**
+   * Effectually maps over the value the fiber computes.
+   *
+   * @since 2.0.0
+   * @category mapping
+   */
   <A, A2, E2>(f: (a: A) => Effect.Effect<A2, E2>): <E>(self: Fiber<A, E>) => Fiber<A2, E2 | E>
+  /**
+   * Effectually maps over the value the fiber computes.
+   *
+   * @since 2.0.0
+   * @category mapping
+   */
   <A, E, A2, E2>(self: Fiber<A, E>, f: (a: A) => Effect.Effect<A2, E2>): Fiber<A2, E | E2>
 } = internal.mapEffect
 
@@ -566,7 +636,21 @@ export const mapEffect: {
  * @category mapping
  */
 export const mapFiber: {
+  /**
+   * Passes the success of this fiber to the specified callback, and continues
+   * with the fiber that it returns.
+   *
+   * @since 2.0.0
+   * @category mapping
+   */
   <E, E2, A, B>(f: (a: A) => Fiber<B, E2>): (self: Fiber<A, E>) => Effect.Effect<Fiber<B, E | E2>>
+  /**
+   * Passes the success of this fiber to the specified callback, and continues
+   * with the fiber that it returns.
+   *
+   * @since 2.0.0
+   * @category mapping
+   */
   <A, E, E2, B>(self: Fiber<A, E>, f: (a: A) => Fiber<B, E2>): Effect.Effect<Fiber<B, E | E2>>
 } = internal.mapFiber
 
@@ -577,12 +661,24 @@ export const mapFiber: {
  * @category folding
  */
 export const match: {
+  /**
+   * Folds over the `Fiber` or `RuntimeFiber`.
+   *
+   * @since 2.0.0
+   * @category folding
+   */
   <A, E, Z>(
     options: {
       readonly onFiber: (fiber: Fiber<A, E>) => Z
       readonly onRuntimeFiber: (fiber: RuntimeFiber<A, E>) => Z
     }
   ): (self: Fiber<A, E>) => Z
+  /**
+   * Folds over the `Fiber` or `RuntimeFiber`.
+   *
+   * @since 2.0.0
+   * @category folding
+   */
   <A, E, Z>(
     self: Fiber<A, E>,
     options: {
@@ -609,7 +705,23 @@ export const never: Fiber<never> = internal.never
  * @category alternatives
  */
 export const orElse: {
+  /**
+   * Returns a fiber that prefers `this` fiber, but falls back to the `that` one
+   * when `this` one fails. Interrupting the returned fiber will interrupt both
+   * fibers, sequentially, from left to right.
+   *
+   * @since 2.0.0
+   * @category alternatives
+   */
   <A2, E2>(that: Fiber<A2, E2>): <A, E>(self: Fiber<A, E>) => Fiber<A2 | A, E2 | E>
+  /**
+   * Returns a fiber that prefers `this` fiber, but falls back to the `that` one
+   * when `this` one fails. Interrupting the returned fiber will interrupt both
+   * fibers, sequentially, from left to right.
+   *
+   * @since 2.0.0
+   * @category alternatives
+   */
   <A, E, A2, E2>(self: Fiber<A, E>, that: Fiber<A2, E2>): Fiber<A | A2, E | E2>
 } = internal.orElse
 
@@ -622,7 +734,23 @@ export const orElse: {
  * @category alternatives
  */
 export const orElseEither: {
+  /**
+   * Returns a fiber that prefers `this` fiber, but falls back to the `that` one
+   * when `this` one fails. Interrupting the returned fiber will interrupt both
+   * fibers, sequentially, from left to right.
+   *
+   * @since 2.0.0
+   * @category alternatives
+   */
   <A2, E2>(that: Fiber<A2, E2>): <A, E>(self: Fiber<A, E>) => Fiber<Either.Either<A2, A>, E2 | E>
+  /**
+   * Returns a fiber that prefers `this` fiber, but falls back to the `that` one
+   * when `this` one fails. Interrupting the returned fiber will interrupt both
+   * fibers, sequentially, from left to right.
+   *
+   * @since 2.0.0
+   * @category alternatives
+   */
   <A, E, A2, E2>(self: Fiber<A, E>, that: Fiber<A2, E2>): Fiber<Either.Either<A2, A>, E | E2>
 } = internal.orElseEither
 
@@ -704,7 +832,21 @@ export {
  * @category zipping
  */
 export const zip: {
+  /**
+   * Zips this fiber and the specified fiber together, producing a tuple of
+   * their output.
+   *
+   * @since 2.0.0
+   * @category zipping
+   */
   <A2, E2>(that: Fiber<A2, E2>): <A, E>(self: Fiber<A, E>) => Fiber<[A, A2], E2 | E>
+  /**
+   * Zips this fiber and the specified fiber together, producing a tuple of
+   * their output.
+   *
+   * @since 2.0.0
+   * @category zipping
+   */
   <A, E, A2, E2>(self: Fiber<A, E>, that: Fiber<A2, E2>): Fiber<[A, A2], E | E2>
 } = circular.zipFiber
 
@@ -715,7 +857,19 @@ export const zip: {
  * @category zipping
  */
 export const zipLeft: {
+  /**
+   * Same as `zip` but discards the output of that `Fiber`.
+   *
+   * @since 2.0.0
+   * @category zipping
+   */
   <A2, E2>(that: Fiber<A2, E2>): <A, E>(self: Fiber<A, E>) => Fiber<A, E2 | E>
+  /**
+   * Same as `zip` but discards the output of that `Fiber`.
+   *
+   * @since 2.0.0
+   * @category zipping
+   */
   <A, E, A2, E2>(self: Fiber<A, E>, that: Fiber<A2, E2>): Fiber<A, E | E2>
 } = circular.zipLeftFiber
 
@@ -726,7 +880,19 @@ export const zipLeft: {
  * @category zipping
  */
 export const zipRight: {
+  /**
+   * Same as `zip` but discards the output of this `Fiber`.
+   *
+   * @since 2.0.0
+   * @category zipping
+   */
   <A2, E2>(that: Fiber<A2, E2>): <A, E>(self: Fiber<A, E>) => Fiber<A2, E2 | E>
+  /**
+   * Same as `zip` but discards the output of this `Fiber`.
+   *
+   * @since 2.0.0
+   * @category zipping
+   */
   <A, E, A2, E2>(self: Fiber<A, E>, that: Fiber<A2, E2>): Fiber<A2, E | E2>
 } = circular.zipRightFiber
 
@@ -739,6 +905,22 @@ export const zipRight: {
  * @category zipping
  */
 export const zipWith: {
+  /**
+   * Zips this fiber with the specified fiber, combining their results using the
+   * specified combiner function. Both joins and interruptions are performed in
+   * sequential order from left to right.
+   *
+   * @since 2.0.0
+   * @category zipping
+   */
   <B, E2, A, C>(that: Fiber<B, E2>, f: (a: A, b: B) => C): <E>(self: Fiber<A, E>) => Fiber<C, E2 | E>
+  /**
+   * Zips this fiber with the specified fiber, combining their results using the
+   * specified combiner function. Both joins and interruptions are performed in
+   * sequential order from left to right.
+   *
+   * @since 2.0.0
+   * @category zipping
+   */
   <A, E, B, E2, C>(self: Fiber<A, E>, that: Fiber<B, E2>, f: (a: A, b: B) => C): Fiber<C, E | E2>
 } = circular.zipWithFiber

package/src/FiberHandle.ts

@@ -162,6 +162,13 @@ const isInternalInterruption = Cause.reduceWithContext(undefined, {
  * @categories combinators
  */
 export const unsafeSet: {
+  /**
+   * Set the fiber in a FiberHandle. When the fiber completes, it will be removed from the FiberHandle.
+   * If a fiber is already running, it will be interrupted unless `options.onlyIfMissing` is set.
+   *
+   * @since 2.0.0
+   * @categories combinators
+   */
   <A, E, XE extends E, XA extends A>(
     fiber: Fiber.RuntimeFiber<XA, XE>,
     options?: {
@@ -170,6 +177,13 @@ export const unsafeSet: {
       readonly propagateInterruption?: boolean | undefined
     }
   ): (self: FiberHandle<A, E>) => void
+  /**
+   * Set the fiber in a FiberHandle. When the fiber completes, it will be removed from the FiberHandle.
+   * If a fiber is already running, it will be interrupted unless `options.onlyIfMissing` is set.
+   *
+   * @since 2.0.0
+   * @categories combinators
+   */
   <A, E, XE extends E, XA extends A>(
     self: FiberHandle<A, E>,
     fiber: Fiber.RuntimeFiber<XA, XE>,
@@ -229,6 +243,13 @@ export const unsafeSet: {
  * @categories combinators
  */
 export const set: {
+  /**
+   * Set the fiber in the FiberHandle. When the fiber completes, it will be removed from the FiberHandle.
+   * If a fiber already exists in the FiberHandle, it will be interrupted unless `options.onlyIfMissing` is set.
+   *
+   * @since 2.0.0
+   * @categories combinators
+   */
   <A, E, XE extends E, XA extends A>(
     fiber: Fiber.RuntimeFiber<XA, XE>,
     options?: {
@@ -236,6 +257,13 @@ export const set: {
       readonly propagateInterruption?: boolean | undefined
     }
   ): (self: FiberHandle<A, E>) => Effect.Effect<void>
+  /**
+   * Set the fiber in the FiberHandle. When the fiber completes, it will be removed from the FiberHandle.
+   * If a fiber already exists in the FiberHandle, it will be interrupted unless `options.onlyIfMissing` is set.
+   *
+   * @since 2.0.0
+   * @categories combinators
+   */
   <A, E, XE extends E, XA extends A>(
     self: FiberHandle<A, E>,
     fiber: Fiber.RuntimeFiber<XA, XE>,
@@ -320,6 +348,13 @@ const constInterruptedFiber = (function() {
  * @categories combinators
  */
 export const run: {
+  /**
+   * Run an Effect and add the forked fiber to the FiberHandle.
+   * When the fiber completes, it will be removed from the FiberHandle.
+   *
+   * @since 2.0.0
+   * @categories combinators
+   */
   <A, E>(
     self: FiberHandle<A, E>,
     options?: {
@@ -329,6 +364,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>
+  /**
+   * Run an Effect and add the forked fiber to the FiberHandle.
+   * When the fiber completes, it will be removed from the FiberHandle.
+   *
+   * @since 2.0.0
+   * @categories combinators
+   */
   <A, E, R, XE extends E, XA extends A>(
     self: FiberHandle<A, E>,
     effect: Effect.Effect<XA, XE, R>,

package/src/FiberId.ts

@@ -122,7 +122,19 @@ export const isComposite: (self: FiberId) => self is Composite = internal.isComp
  * @category constructors
  */
 export const combine: {
+  /**
+   * Combine two `FiberId`s.
+   *
+   * @since 2.0.0
+   * @category constructors
+   */
   (that: FiberId): (self: FiberId) => FiberId
+  /**
+   * Combine two `FiberId`s.
+   *
+   * @since 2.0.0
+   * @category constructors
+   */
   (self: FiberId, that: FiberId): FiberId
 } = internal.combine
 
@@ -141,7 +153,19 @@ export const combineAll: (fiberIds: HashSet.HashSet<FiberId>) => FiberId = inter
  * @category utils
  */
 export const getOrElse: {
+  /**
+   * Returns this `FiberId` if it is not `None`, otherwise returns that `FiberId`.
+   *
+   * @since 2.0.0
+   * @category utils
+   */
   (that: FiberId): (self: FiberId) => FiberId
+  /**
+   * Returns this `FiberId` if it is not `None`, otherwise returns that `FiberId`.
+   *
+   * @since 2.0.0
+   * @category utils
+   */
   (self: FiberId, that: FiberId): FiberId
 } = internal.getOrElse
 

package/src/FiberMap.ts

@@ -177,6 +177,13 @@ const isInternalInterruption = Cause.reduceWithContext(undefined, {
  * @categories combinators
  */
 export const unsafeSet: {
+  /**
+   * Add a fiber to the FiberMap. When the fiber completes, it will be removed from the FiberMap.
+   * If the key already exists in the FiberMap, the previous fiber will be interrupted.
+   *
+   * @since 2.0.0
+   * @categories combinators
+   */
   <K, A, E, XE extends E, XA extends A>(
     key: K,
     fiber: Fiber.RuntimeFiber<XA, XE>,
@@ -186,6 +193,13 @@ export const unsafeSet: {
       readonly propagateInterruption?: boolean | undefined
     } | undefined
   ): (self: FiberMap<K, A, E>) => void
+  /**
+   * Add a fiber to the FiberMap. When the fiber completes, it will be removed from the FiberMap.
+   * If the key already exists in the FiberMap, the previous fiber will be interrupted.
+   *
+   * @since 2.0.0
+   * @categories combinators
+   */
   <K, A, E, XE extends E, XA extends A>(
     self: FiberMap<K, A, E>,
     key: K,
@@ -253,6 +267,13 @@ export const unsafeSet: {
  * @categories combinators
  */
 export const set: {
+  /**
+   * Add a fiber to the FiberMap. When the fiber completes, it will be removed from the FiberMap.
+   * If the key already exists in the FiberMap, the previous fiber will be interrupted.
+   *
+   * @since 2.0.0
+   * @categories combinators
+   */
   <K, A, E, XE extends E, XA extends A>(
     key: K,
     fiber: Fiber.RuntimeFiber<XA, XE>,
@@ -261,6 +282,13 @@ export const set: {
       readonly propagateInterruption?: boolean | undefined
     } | undefined
   ): (self: FiberMap<K, A, E>) => Effect.Effect<void>
+  /**
+   * Add a fiber to the FiberMap. When the fiber completes, it will be removed from the FiberMap.
+   * If the key already exists in the FiberMap, the previous fiber will be interrupted.
+   *
+   * @since 2.0.0
+   * @categories combinators
+   */
   <K, A, E, XE extends E, XA extends A>(
     self: FiberMap<K, A, E>,
     key: K,
@@ -296,16 +324,35 @@ export const set: {
  * @categories combinators
  */
 export const unsafeGet: {
+  /**
+   * Retrieve a fiber from the FiberMap.
+   *
+   * @since 2.0.0
+   * @categories combinators
+   */
   <K>(key: K): <A, E>(self: FiberMap<K, A, E>) => Option.Option<Fiber.RuntimeFiber<A, E>>
+  /**
+   * Retrieve a fiber from the FiberMap.
+   *
+   * @since 2.0.0
+   * @categories combinators
+   */
   <K, A, E>(self: FiberMap<K, A, E>, key: K): Option.Option<Fiber.RuntimeFiber<A, E>>
 } = dual<
-  <K>(
-    key: K
-  ) => <A, E>(self: FiberMap<K, A, E>) => Option.Option<Fiber.RuntimeFiber<A, E>>,
-  <K, A, E>(
-    self: FiberMap<K, A, E>,
-    key: K
-  ) => Option.Option<Fiber.RuntimeFiber<A, E>>
+  /**
+   * Retrieve a fiber from the FiberMap.
+   *
+   * @since 2.0.0
+   * @categories combinators
+   */
+  <K>(key: K) => <A, E>(self: FiberMap<K, A, E>) => Option.Option<Fiber.RuntimeFiber<A, E>>,
+  /**
+   * Retrieve a fiber from the FiberMap.
+   *
+   * @since 2.0.0
+   * @categories combinators
+   */
+  <K, A, E>(self: FiberMap<K, A, E>, key: K) => Option.Option<Fiber.RuntimeFiber<A, E>>
 >(2, (self, key) => self.state._tag === "Closed" ? Option.none() : MutableHashMap.get(self.state.backing, key))
 
 /**
@@ -315,16 +362,35 @@ export const unsafeGet: {
  * @categories combinators
  */
 export const get: {
+  /**
+   * Retrieve a fiber from the FiberMap.
+   *
+   * @since 2.0.0
+   * @categories combinators
+   */
   <K>(key: K): <A, E>(self: FiberMap<K, A, E>) => Effect.Effect<Fiber.RuntimeFiber<A, E>, NoSuchElementException>
+  /**
+   * Retrieve a fiber from the FiberMap.
+   *
+   * @since 2.0.0
+   * @categories combinators
+   */
   <K, A, E>(self: FiberMap<K, A, E>, key: K): Effect.Effect<Fiber.RuntimeFiber<A, E>, NoSuchElementException>
 } = dual<
-  <K>(
-    key: K
-  ) => <A, E>(self: FiberMap<K, A, E>) => Effect.Effect<Fiber.RuntimeFiber<A, E>, NoSuchElementException>,
-  <K, A, E>(
-    self: FiberMap<K, A, E>,
-    key: K
-  ) => Effect.Effect<Fiber.RuntimeFiber<A, E>, NoSuchElementException>
+  /**
+   * Retrieve a fiber from the FiberMap.
+   *
+   * @since 2.0.0
+   * @categories combinators
+   */
+  <K>(key: K) => <A, E>(self: FiberMap<K, A, E>) => Effect.Effect<Fiber.RuntimeFiber<A, E>, NoSuchElementException>,
+  /**
+   * Retrieve a fiber from the FiberMap.
+   *
+   * @since 2.0.0
+   * @categories combinators
+   */
+  <K, A, E>(self: FiberMap<K, A, E>, key: K) => Effect.Effect<Fiber.RuntimeFiber<A, E>, NoSuchElementException>
 >(2, (self, key) => Effect.suspend(() => unsafeGet(self, key)))
 
 /**
@@ -334,7 +400,19 @@ export const get: {
  * @categories combinators
  */
 export const unsafeHas: {
+  /**
+   * Check if a key exists in the FiberMap.
+   *
+   * @since 2.0.0
+   * @categories combinators
+   */
   <K>(key: K): <A, E>(self: FiberMap<K, A, E>) => boolean
+  /**
+   * Check if a key exists in the FiberMap.
+   *
+   * @since 2.0.0
+   * @categories combinators
+   */
   <K, A, E>(self: FiberMap<K, A, E>, key: K): boolean
 } = dual(
   2,
@@ -349,7 +427,19 @@ export const unsafeHas: {
  * @categories combinators
  */
 export const has: {
+  /**
+   * Check if a key exists in the FiberMap.
+   *
+   * @since 2.0.0
+   * @categories combinators
+   */
   <K>(key: K): <A, E>(self: FiberMap<K, A, E>) => Effect.Effect<boolean>
+  /**
+   * Check if a key exists in the FiberMap.
+   *
+   * @since 2.0.0
+   * @categories combinators
+   */
   <K, A, E>(self: FiberMap<K, A, E>, key: K): Effect.Effect<boolean>
 } = dual(
   2,
@@ -363,16 +453,35 @@ export const has: {
  * @categories combinators
  */
 export const remove: {
+  /**
+   * Remove a fiber from the FiberMap, interrupting it if it exists.
+   *
+   * @since 2.0.0
+   * @categories combinators
+   */
   <K>(key: K): <A, E>(self: FiberMap<K, A, E>) => Effect.Effect<void>
+  /**
+   * Remove a fiber from the FiberMap, interrupting it if it exists.
+   *
+   * @since 2.0.0
+   * @categories combinators
+   */
   <K, A, E>(self: FiberMap<K, A, E>, key: K): Effect.Effect<void>
 } = dual<
-  <K>(
-    key: K
-  ) => <A, E>(self: FiberMap<K, A, E>) => Effect.Effect<void>,
-  <K, A, E>(
-    self: FiberMap<K, A, E>,
-    key: K
-  ) => Effect.Effect<void>
+  /**
+   * Remove a fiber from the FiberMap, interrupting it if it exists.
+   *
+   * @since 2.0.0
+   * @categories combinators
+   */
+  <K>(key: K) => <A, E>(self: FiberMap<K, A, E>) => Effect.Effect<void>,
+  /**
+   * Remove a fiber from the FiberMap, interrupting it if it exists.
+   *
+   * @since 2.0.0
+   * @categories combinators
+   */
+  <K, A, E>(self: FiberMap<K, A, E>, key: K) => Effect.Effect<void>
 >(2, (self, key) =>
   Effect.withFiberRuntime((removeFiber) => {
     if (self.state._tag === "Closed") {
@@ -419,6 +528,13 @@ const constInterruptedFiber = (function() {
  * @categories combinators
  */
 export const run: {
+  /**
+   * Run an Effect and add the forked fiber to the FiberMap.
+   * When the fiber completes, it will be removed from the FiberMap.
+   *
+   * @since 2.0.0
+   * @categories combinators
+   */
   <K, A, E>(
     self: FiberMap<K, A, E>,
     key: K,
@@ -429,6 +545,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>
+  /**
+   * Run an Effect and add the forked fiber to the FiberMap.
+   * When the fiber completes, it will be removed from the FiberMap.
+   *
+   * @since 2.0.0
+   * @categories combinators
+   */
   <K, A, E, R, XE extends E, XA extends A>(
     self: FiberMap<K, A, E>,
     key: K,