effect 3.8.4 → 3.8.5

package/src/ScheduleInterval.ts

@@ -56,7 +56,21 @@ export const empty: Interval = internal.empty
  * @category ordering
  */
 export const lessThan: {
+  /**
+   * Returns `true` if this `Interval` is less than `that` interval, `false`
+   * otherwise.
+   *
+   * @since 2.0.0
+   * @category ordering
+   */
   (that: Interval): (self: Interval) => boolean
+  /**
+   * Returns `true` if this `Interval` is less than `that` interval, `false`
+   * otherwise.
+   *
+   * @since 2.0.0
+   * @category ordering
+   */
   (self: Interval, that: Interval): boolean
 } = internal.lessThan
 
@@ -67,7 +81,19 @@ export const lessThan: {
  * @category ordering
  */
 export const min: {
+  /**
+   * Returns the minimum of two `Interval`s.
+   *
+   * @since 2.0.0
+   * @category ordering
+   */
   (that: Interval): (self: Interval) => Interval
+  /**
+   * Returns the minimum of two `Interval`s.
+   *
+   * @since 2.0.0
+   * @category ordering
+   */
   (self: Interval, that: Interval): Interval
 } = internal.min
 
@@ -78,7 +104,19 @@ export const min: {
  * @category ordering
  */
 export const max: {
+  /**
+   * Returns the maximum of two `Interval`s.
+   *
+   * @since 2.0.0
+   * @category ordering
+   */
   (that: Interval): (self: Interval) => Interval
+  /**
+   * Returns the maximum of two `Interval`s.
+   *
+   * @since 2.0.0
+   * @category ordering
+   */
   (self: Interval, that: Interval): Interval
 } = internal.max
 
@@ -106,7 +144,21 @@ export const isNonEmpty: (self: Interval) => boolean = internal.isNonEmpty
  * @category ordering
  */
 export const intersect: {
+  /**
+   * Computes a new `Interval` which is the intersection of this `Interval` and
+   * that `Interval`.
+   *
+   * @since 2.0.0
+   * @category ordering
+   */
   (that: Interval): (self: Interval) => Interval
+  /**
+   * Computes a new `Interval` which is the intersection of this `Interval` and
+   * that `Interval`.
+   *
+   * @since 2.0.0
+   * @category ordering
+   */
   (self: Interval, that: Interval): Interval
 } = internal.intersect
 
@@ -128,7 +180,23 @@ export const size: (self: Interval) => Duration.Duration = internal.size
  * @category utils
  */
 export const union: {
+  /**
+   * Computes a new `Interval` which is the union of this `Interval` and that
+   * `Interval` as a `Some`, otherwise returns `None` if the two intervals cannot
+   * form a union.
+   *
+   * @since 2.0.0
+   * @category utils
+   */
   (that: Interval): (self: Interval) => Option.Option<Interval>
+  /**
+   * Computes a new `Interval` which is the union of this `Interval` and that
+   * `Interval` as a `Some`, otherwise returns `None` if the two intervals cannot
+   * form a union.
+   *
+   * @since 2.0.0
+   * @category utils
+   */
   (self: Interval, that: Interval): Option.Option<Interval>
 } = internal.union
 

package/src/ScheduleIntervals.ts

@@ -59,7 +59,19 @@ export const fromIterable: (intervals: Iterable<Interval.Interval>) => Intervals
  * @category utils
  */
 export const union: {
+  /**
+   * Computes the union of this `Intervals` and  that `Intervals`
+   *
+   * @since 2.0.0
+   * @category utils
+   */
   (that: Intervals): (self: Intervals) => Intervals
+  /**
+   * Computes the union of this `Intervals` and  that `Intervals`
+   *
+   * @since 2.0.0
+   * @category utils
+   */
   (self: Intervals, that: Intervals): Intervals
 } = internal.union
 
@@ -70,7 +82,19 @@ export const union: {
  * @category utils
  */
 export const intersect: {
+  /**
+   * Produces the intersection of this `Intervals` and that `Intervals`.
+   *
+   * @since 2.0.0
+   * @category utils
+   */
   (that: Intervals): (self: Intervals) => Intervals
+  /**
+   * Produces the intersection of this `Intervals` and that `Intervals`.
+   *
+   * @since 2.0.0
+   * @category utils
+   */
   (self: Intervals, that: Intervals): Intervals
 } = internal.intersect
 
@@ -98,7 +122,21 @@ export const end: (self: Intervals) => number = internal.end
  * @category ordering
  */
 export const lessThan: {
+  /**
+   * Returns `true` if the start of this `Intervals` is before the start of that
+   * `Intervals`, `false` otherwise.
+   *
+   * @since 2.0.0
+   * @category ordering
+   */
   (that: Intervals): (self: Intervals) => boolean
+  /**
+   * Returns `true` if the start of this `Intervals` is before the start of that
+   * `Intervals`, `false` otherwise.
+   *
+   * @since 2.0.0
+   * @category ordering
+   */
   (self: Intervals, that: Intervals): boolean
 } = internal.lessThan
 
@@ -117,6 +155,18 @@ export const isNonEmpty: (self: Intervals) => boolean = internal.isNonEmpty
  * @category ordering
  */
 export const max: {
+  /**
+   * Returns the maximum of the two `Intervals` (i.e. which has the latest start).
+   *
+   * @since 2.0.0
+   * @category ordering
+   */
   (that: Intervals): (self: Intervals) => Intervals
+  /**
+   * Returns the maximum of the two `Intervals` (i.e. which has the latest start).
+   *
+   * @since 2.0.0
+   * @category ordering
+   */
   (self: Intervals, that: Intervals): Intervals
 } = internal.max

package/src/Scheduler.ts

@@ -348,6 +348,8 @@ export const currentScheduler: FiberRef<Scheduler> = globalValue(
 
 /** @internal */
 export const withScheduler = dual<
+  /** @internal */
   (scheduler: Scheduler) => <A, E, R>(self: Effect<A, E, R>) => Effect<A, E, R>,
+  /** @internal */
   <A, E, R>(self: Effect<A, E, R>, scheduler: Scheduler) => Effect<A, E, R>
 >(2, (self, scheduler) => core.fiberRefLocally(self, currentScheduler, scheduler))

package/src/Scope.ts

@@ -159,7 +159,25 @@ export const close: (self: CloseableScope, exit: Exit.Exit<unknown, unknown>) =>
  * @category utils
  */
 export const extend: {
+  /**
+   * Extends the scope of an `Effect` that requires a scope into this scope.
+   * It provides this scope to the effect but does not close the scope when the
+   * effect completes execution. This allows extending a scoped value into a
+   * larger scope.
+   *
+   * @since 2.0.0
+   * @category utils
+   */
   (scope: Scope): <A, E, R>(effect: Effect.Effect<A, E, R>) => Effect.Effect<A, E, Exclude<R, Scope>>
+  /**
+   * Extends the scope of an `Effect` that requires a scope into this scope.
+   * It provides this scope to the effect but does not close the scope when the
+   * effect completes execution. This allows extending a scoped value into a
+   * larger scope.
+   *
+   * @since 2.0.0
+   * @category utils
+   */
   <A, E, R>(effect: Effect.Effect<A, E, R>, scope: Scope): Effect.Effect<A, E, Exclude<R, Scope>>
 } = fiberRuntime.scopeExtend
 
@@ -185,7 +203,25 @@ export const fork: (
  * @category destructors
  */
 export const use: {
+  /**
+   * Provides this closeable scope to an `Effect` that requires a scope,
+   * guaranteeing that the scope is closed with the result of that effect as
+   * soon as the effect completes execution, whether by success, failure, or
+   * interruption.
+   *
+   * @since 2.0.0
+   * @category destructors
+   */
   (scope: CloseableScope): <A, E, R>(effect: Effect.Effect<A, E, R>) => Effect.Effect<A, E, Exclude<R, Scope>>
+  /**
+   * Provides this closeable scope to an `Effect` that requires a scope,
+   * guaranteeing that the scope is closed with the result of that effect as
+   * soon as the effect completes execution, whether by success, failure, or
+   * interruption.
+   *
+   * @since 2.0.0
+   * @category destructors
+   */
   <A, E, R>(effect: Effect.Effect<A, E, R>, scope: CloseableScope): Effect.Effect<A, E, Exclude<R, Scope>>
 } = fiberRuntime.scopeUse
 

package/src/ScopedRef.ts

@@ -91,6 +91,28 @@ export const make: <A>(evaluate: LazyArg<A>) => Effect.Effect<ScopedRef<A>, neve
  * @category getters
  */
 export const set: {
+  /**
+   * Sets the value of this reference to the specified resourcefully-created
+   * value. Any resources associated with the old value will be released.
+   *
+   * This method will not return until either the reference is successfully
+   * changed to the new value, with old resources released, or until the attempt
+   * to acquire a new value fails.
+   *
+   * @since 2.0.0
+   * @category getters
+   */
   <A, R, E>(acquire: Effect.Effect<A, E, R>): (self: ScopedRef<A>) => Effect.Effect<void, E, Exclude<R, Scope.Scope>>
+  /**
+   * Sets the value of this reference to the specified resourcefully-created
+   * value. Any resources associated with the old value will be released.
+   *
+   * This method will not return until either the reference is successfully
+   * changed to the new value, with old resources released, or until the attempt
+   * to acquire a new value fails.
+   *
+   * @since 2.0.0
+   * @category getters
+   */
   <A, R, E>(self: ScopedRef<A>, acquire: Effect.Effect<A, E, R>): Effect.Effect<void, E, Exclude<R, Scope.Scope>>
 } = internal.set