effect 3.8.4 → 3.8.5

package/src/TPriorityQueue.ts

@@ -107,7 +107,19 @@ export const make: <A>(order: Order.Order<A>) => (...elements: Array<A>) => STM.
  * @category mutations
  */
 export const offer: {
+  /**
+   * Offers the specified value to the queue.
+   *
+   * @since 2.0.0
+   * @category mutations
+   */
   <A>(value: A): (self: TPriorityQueue<A>) => STM.STM<void>
+  /**
+   * Offers the specified value to the queue.
+   *
+   * @since 2.0.0
+   * @category mutations
+   */
   <A>(self: TPriorityQueue<A>, value: A): STM.STM<void>
 } = internal.offer
 
@@ -118,7 +130,19 @@ export const offer: {
  * @category mutations
  */
 export const offerAll: {
+  /**
+   * Offers all of the elements in the specified collection to the queue.
+   *
+   * @since 2.0.0
+   * @category mutations
+   */
   <A>(values: Iterable<A>): (self: TPriorityQueue<A>) => STM.STM<void>
+  /**
+   * Offers all of the elements in the specified collection to the queue.
+   *
+   * @since 2.0.0
+   * @category mutations
+   */
   <A>(self: TPriorityQueue<A>, values: Iterable<A>): STM.STM<void>
 } = internal.offerAll
 
@@ -147,7 +171,19 @@ export const peekOption: <A>(self: TPriorityQueue<A>) => STM.STM<Option.Option<A
  * @category getters
  */
 export const removeIf: {
+  /**
+   * Removes all elements from the queue matching the specified predicate.
+   *
+   * @since 2.0.0
+   * @category getters
+   */
   <A>(predicate: Predicate<A>): (self: TPriorityQueue<A>) => STM.STM<void>
+  /**
+   * Removes all elements from the queue matching the specified predicate.
+   *
+   * @since 2.0.0
+   * @category getters
+   */
   <A>(self: TPriorityQueue<A>, predicate: Predicate<A>): STM.STM<void>
 } = internal.removeIf
 
@@ -158,7 +194,19 @@ export const removeIf: {
  * @category getters
  */
 export const retainIf: {
+  /**
+   * Retains only elements from the queue matching the specified predicate.
+   *
+   * @since 2.0.0
+   * @category getters
+   */
   <A>(predicate: Predicate<A>): (self: TPriorityQueue<A>) => STM.STM<void>
+  /**
+   * Retains only elements from the queue matching the specified predicate.
+   *
+   * @since 2.0.0
+   * @category getters
+   */
   <A>(self: TPriorityQueue<A>, predicate: Predicate<A>): STM.STM<void>
 } = internal.retainIf
 
@@ -202,7 +250,19 @@ export const takeOption: <A>(self: TPriorityQueue<A>) => STM.STM<Option.Option<A
  * @category mutations
  */
 export const takeUpTo: {
+  /**
+   * Takes up to the specified maximum number of elements from the queue.
+   *
+   * @since 2.0.0
+   * @category mutations
+   */
   (n: number): <A>(self: TPriorityQueue<A>) => STM.STM<Array<A>>
+  /**
+   * Takes up to the specified maximum number of elements from the queue.
+   *
+   * @since 2.0.0
+   * @category mutations
+   */
   <A>(self: TPriorityQueue<A>, n: number): STM.STM<Array<A>>
 } = internal.takeUpTo
 

package/src/TPubSub.ts

@@ -123,7 +123,21 @@ export const isShutdown: <A>(self: TPubSub<A>) => STM.STM<boolean> = internal.is
  * @category mutations
  */
 export const publish: {
+  /**
+   * Publishes a message to the `TPubSub`, returning whether the message was published
+   * to the `TPubSub`.
+   *
+   * @since 2.0.0
+   * @category mutations
+   */
   <A>(value: A): (self: TPubSub<A>) => STM.STM<boolean>
+  /**
+   * Publishes a message to the `TPubSub`, returning whether the message was published
+   * to the `TPubSub`.
+   *
+   * @since 2.0.0
+   * @category mutations
+   */
   <A>(self: TPubSub<A>, value: A): STM.STM<boolean>
 } = internal.publish
 
@@ -135,7 +149,21 @@ export const publish: {
  * @category mutations
  */
 export const publishAll: {
+  /**
+   * Publishes all of the specified messages to the `TPubSub`, returning whether they
+   * were published to the `TPubSub`.
+   *
+   * @since 2.0.0
+   * @category mutations
+   */
   <A>(iterable: Iterable<A>): (self: TPubSub<A>) => STM.STM<boolean>
+  /**
+   * Publishes all of the specified messages to the `TPubSub`, returning whether they
+   * were published to the `TPubSub`.
+   *
+   * @since 2.0.0
+   * @category mutations
+   */
   <A>(self: TPubSub<A>, iterable: Iterable<A>): STM.STM<boolean>
 } = internal.publishAll
 

package/src/TQueue.ts

@@ -271,7 +271,19 @@ export const isShutdown: <A>(self: TQueue<A>) => STM.STM<boolean> = internal.isS
  * @category mutations
  */
 export const offer: {
+  /**
+   * Places one value in the queue.
+   *
+   * @since 2.0.0
+   * @category mutations
+   */
   <A>(value: A): (self: TEnqueue<A>) => STM.STM<void>
+  /**
+   * Places one value in the queue.
+   *
+   * @since 2.0.0
+   * @category mutations
+   */
   <A>(self: TEnqueue<A>, value: A): STM.STM<void>
 } = internal.offer
 
@@ -294,7 +306,43 @@ export const offer: {
  * @category mutations
  */
 export const offerAll: {
+  /**
+   * For Bounded TQueue: uses the `BackPressure` Strategy, places the values in
+   * the queue and always returns true. If the queue has reached capacity, then
+   * the fiber performing the `offerAll` will be suspended until there is room
+   * in the queue.
+   *
+   * For Unbounded TQueue: Places all values in the queue and returns true.
+   *
+   * For Sliding TQueue: uses `Sliding` Strategy If there is room in the queue,
+   * it places the values otherwise it removes the old elements and enqueues the
+   * new ones. Always returns true.
+   *
+   * For Dropping TQueue: uses `Dropping` Strategy, It places the values in the
+   * queue but if there is no room it will not enqueue them and return false.
+   *
+   * @since 2.0.0
+   * @category mutations
+   */
   <A>(iterable: Iterable<A>): (self: TEnqueue<A>) => STM.STM<boolean>
+  /**
+   * For Bounded TQueue: uses the `BackPressure` Strategy, places the values in
+   * the queue and always returns true. If the queue has reached capacity, then
+   * the fiber performing the `offerAll` will be suspended until there is room
+   * in the queue.
+   *
+   * For Unbounded TQueue: Places all values in the queue and returns true.
+   *
+   * For Sliding TQueue: uses `Sliding` Strategy If there is room in the queue,
+   * it places the values otherwise it removes the old elements and enqueues the
+   * new ones. Always returns true.
+   *
+   * For Dropping TQueue: uses `Dropping` Strategy, It places the values in the
+   * queue but if there is no room it will not enqueue them and return false.
+   *
+   * @since 2.0.0
+   * @category mutations
+   */
   <A>(self: TEnqueue<A>, iterable: Iterable<A>): STM.STM<boolean>
 } = internal.offerAll
 
@@ -334,7 +382,23 @@ export const poll: <A>(self: TDequeue<A>) => STM.STM<Option.Option<A>> = interna
  * @category mutations
  */
 export const seek: {
+  /**
+   * Drops elements from the queue while they do not satisfy the predicate,
+   * taking and returning the first element that does satisfy the predicate.
+   * Retries if no elements satisfy the predicate.
+   *
+   * @since 2.0.0
+   * @category mutations
+   */
   <A>(predicate: Predicate<A>): (self: TDequeue<A>) => STM.STM<A>
+  /**
+   * Drops elements from the queue while they do not satisfy the predicate,
+   * taking and returning the first element that does satisfy the predicate.
+   * Retries if no elements satisfy the predicate.
+   *
+   * @since 2.0.0
+   * @category mutations
+   */
   <A>(self: TDequeue<A>, predicate: Predicate<A>): STM.STM<A>
 } = internal.seek
 
@@ -395,7 +459,23 @@ export const takeAll: <A>(self: TDequeue<A>) => STM.STM<Array<A>> = internal.tak
  * @category mutations
  */
 export const takeBetween: {
+  /**
+   * Takes a number of elements from the queue between the specified minimum and
+   * maximum. If there are fewer than the minimum number of elements available,
+   * retries until at least the minimum number of elements have been collected.
+   *
+   * @since 2.0.0
+   * @category mutations
+   */
   (min: number, max: number): <A>(self: TDequeue<A>) => STM.STM<Array<A>>
+  /**
+   * Takes a number of elements from the queue between the specified minimum and
+   * maximum. If there are fewer than the minimum number of elements available,
+   * retries until at least the minimum number of elements have been collected.
+   *
+   * @since 2.0.0
+   * @category mutations
+   */
   <A>(self: TDequeue<A>, min: number, max: number): STM.STM<Array<A>>
 } = internal.takeBetween
 
@@ -408,7 +488,23 @@ export const takeBetween: {
  * @category mutations
  */
 export const takeN: {
+  /**
+   * Takes the specified number of elements from the queue. If there are fewer
+   * than the specified number of elements available, it retries until they
+   * become available.
+   *
+   * @since 2.0.0
+   * @category mutations
+   */
   (n: number): <A>(self: TDequeue<A>) => STM.STM<Array<A>>
+  /**
+   * Takes the specified number of elements from the queue. If there are fewer
+   * than the specified number of elements available, it retries until they
+   * become available.
+   *
+   * @since 2.0.0
+   * @category mutations
+   */
   <A>(self: TDequeue<A>, n: number): STM.STM<Array<A>>
 } = internal.takeN
 
@@ -419,7 +515,19 @@ export const takeN: {
  * @category mutations
  */
 export const takeUpTo: {
+  /**
+   * Takes up to max number of values from the queue.
+   *
+   * @since 2.0.0
+   * @category mutations
+   */
   (max: number): <A>(self: TDequeue<A>) => STM.STM<Array<A>>
+  /**
+   * Takes up to max number of values from the queue.
+   *
+   * @since 2.0.0
+   * @category mutations
+   */
   <A>(self: TDequeue<A>, max: number): STM.STM<Array<A>>
 } = internal.takeUpTo
 

package/src/TReentrantLock.ts

@@ -173,7 +173,19 @@ export const releaseWrite: (self: TReentrantLock) => STM.STM<number> = internal.
  * @category mutations
  */
 export const withLock: {
+  /**
+   * Runs the specified workflow with a lock.
+   *
+   * @since 2.0.0
+   * @category mutations
+   */
   (self: TReentrantLock): <A, E, R>(effect: Effect.Effect<A, E, R>) => Effect.Effect<A, E, R>
+  /**
+   * Runs the specified workflow with a lock.
+   *
+   * @since 2.0.0
+   * @category mutations
+   */
   <A, E, R>(effect: Effect.Effect<A, E, R>, self: TReentrantLock): Effect.Effect<A, E, R>
 } = internal.withLock
 
@@ -184,7 +196,19 @@ export const withLock: {
  * @category mutations
  */
 export const withReadLock: {
+  /**
+   * Runs the specified workflow with a read lock.
+   *
+   * @since 2.0.0
+   * @category mutations
+   */
   (self: TReentrantLock): <A, E, R>(effect: Effect.Effect<A, E, R>) => Effect.Effect<A, E, R>
+  /**
+   * Runs the specified workflow with a read lock.
+   *
+   * @since 2.0.0
+   * @category mutations
+   */
   <A, E, R>(effect: Effect.Effect<A, E, R>, self: TReentrantLock): Effect.Effect<A, E, R>
 } = internal.withReadLock
 
@@ -195,7 +219,19 @@ export const withReadLock: {
  * @category mutations
  */
 export const withWriteLock: {
+  /**
+   * Runs the specified workflow with a write lock.
+   *
+   * @since 2.0.0
+   * @category mutations
+   */
   (self: TReentrantLock): <A, E, R>(effect: Effect.Effect<A, E, R>) => Effect.Effect<A, E, R>
+  /**
+   * Runs the specified workflow with a write lock.
+   *
+   * @since 2.0.0
+   * @category mutations
+   */
   <A, E, R>(effect: Effect.Effect<A, E, R>, self: TReentrantLock): Effect.Effect<A, E, R>
 } = internal.withWriteLock
 

package/src/TRef.ts

@@ -76,7 +76,15 @@ export const get: <A>(self: TRef<A>) => STM.STM<A> = internal.get
  * @category mutations
  */
 export const getAndSet: {
+  /**
+   * @since 2.0.0
+   * @category mutations
+   */
   <A>(value: A): (self: TRef<A>) => STM.STM<A>
+  /**
+   * @since 2.0.0
+   * @category mutations
+   */
   <A>(self: TRef<A>, value: A): STM.STM<A>
 } = internal.getAndSet
 
@@ -85,7 +93,15 @@ export const getAndSet: {
  * @category mutations
  */
 export const getAndUpdate: {
+  /**
+   * @since 2.0.0
+   * @category mutations
+   */
   <A>(f: (a: A) => A): (self: TRef<A>) => STM.STM<A>
+  /**
+   * @since 2.0.0
+   * @category mutations
+   */
   <A>(self: TRef<A>, f: (a: A) => A): STM.STM<A>
 } = internal.getAndUpdate
 
@@ -94,7 +110,15 @@ export const getAndUpdate: {
  * @category mutations
  */
 export const getAndUpdateSome: {
+  /**
+   * @since 2.0.0
+   * @category mutations
+   */
   <A>(f: (a: A) => Option.Option<A>): (self: TRef<A>) => STM.STM<A>
+  /**
+   * @since 2.0.0
+   * @category mutations
+   */
   <A>(self: TRef<A>, f: (a: A) => Option.Option<A>): STM.STM<A>
 } = internal.getAndUpdateSome
 
@@ -109,7 +133,15 @@ export const make: <A>(value: A) => STM.STM<TRef<A>> = internal.make
  * @category mutations
  */
 export const modify: {
+  /**
+   * @since 2.0.0
+   * @category mutations
+   */
   <A, B>(f: (a: A) => readonly [B, A]): (self: TRef<A>) => STM.STM<B>
+  /**
+   * @since 2.0.0
+   * @category mutations
+   */
   <A, B>(self: TRef<A>, f: (a: A) => readonly [B, A]): STM.STM<B>
 } = internal.modify
 
@@ -118,7 +150,15 @@ export const modify: {
  * @category mutations
  */
 export const modifySome: {
+  /**
+   * @since 2.0.0
+   * @category mutations
+   */
   <A, B>(fallback: B, f: (a: A) => Option.Option<readonly [B, A]>): (self: TRef<A>) => STM.STM<B>
+  /**
+   * @since 2.0.0
+   * @category mutations
+   */
   <A, B>(self: TRef<A>, fallback: B, f: (a: A) => Option.Option<readonly [B, A]>): STM.STM<B>
 } = internal.modifySome
 
@@ -127,7 +167,15 @@ export const modifySome: {
  * @category mutations
  */
 export const set: {
+  /**
+   * @since 2.0.0
+   * @category mutations
+   */
   <A>(value: A): (self: TRef<A>) => STM.STM<void>
+  /**
+   * @since 2.0.0
+   * @category mutations
+   */
   <A>(self: TRef<A>, value: A): STM.STM<void>
 } = internal.set
 
@@ -136,7 +184,15 @@ export const set: {
  * @category mutations
  */
 export const setAndGet: {
+  /**
+   * @since 2.0.0
+   * @category mutations
+   */
   <A>(value: A): (self: TRef<A>) => STM.STM<A>
+  /**
+   * @since 2.0.0
+   * @category mutations
+   */
   <A>(self: TRef<A>, value: A): STM.STM<A>
 } = internal.setAndGet
 
@@ -145,7 +201,15 @@ export const setAndGet: {
  * @category mutations
  */
 export const update: {
+  /**
+   * @since 2.0.0
+   * @category mutations
+   */
   <A>(f: (a: A) => A): (self: TRef<A>) => STM.STM<void>
+  /**
+   * @since 2.0.0
+   * @category mutations
+   */
   <A>(self: TRef<A>, f: (a: A) => A): STM.STM<void>
 } = internal.update
 
@@ -154,7 +218,15 @@ export const update: {
  * @category mutations
  */
 export const updateAndGet: {
+  /**
+   * @since 2.0.0
+   * @category mutations
+   */
   <A>(f: (a: A) => A): (self: TRef<A>) => STM.STM<A>
+  /**
+   * @since 2.0.0
+   * @category mutations
+   */
   <A>(self: TRef<A>, f: (a: A) => A): STM.STM<A>
 } = internal.updateAndGet
 
@@ -163,7 +235,15 @@ export const updateAndGet: {
  * @category mutations
  */
 export const updateSome: {
+  /**
+   * @since 2.0.0
+   * @category mutations
+   */
   <A>(f: (a: A) => Option.Option<A>): (self: TRef<A>) => STM.STM<void>
+  /**
+   * @since 2.0.0
+   * @category mutations
+   */
   <A>(self: TRef<A>, f: (a: A) => Option.Option<A>): STM.STM<void>
 } = internal.updateSome
 
@@ -172,6 +252,14 @@ export const updateSome: {
  * @category mutations
  */
 export const updateSomeAndGet: {
+  /**
+   * @since 2.0.0
+   * @category mutations
+   */
   <A>(f: (a: A) => Option.Option<A>): (self: TRef<A>) => STM.STM<A>
+  /**
+   * @since 2.0.0
+   * @category mutations
+   */
   <A>(self: TRef<A>, f: (a: A) => Option.Option<A>): STM.STM<A>
 } = internal.updateSomeAndGet

package/src/TSemaphore.ts

@@ -58,7 +58,15 @@ export const acquire: (self: TSemaphore) => STM.STM<void> = internal.acquire
  * @category mutations
  */
 export const acquireN: {
+  /**
+   * @since 2.0.0
+   * @category mutations
+   */
   (n: number): (self: TSemaphore) => STM.STM<void>
+  /**
+   * @since 2.0.0
+   * @category mutations
+   */
   (self: TSemaphore, n: number): STM.STM<void>
 } = internal.acquireN
 
@@ -85,7 +93,15 @@ export const release: (self: TSemaphore) => STM.STM<void> = internal.release
  * @category mutations
  */
 export const releaseN: {
+  /**
+   * @since 2.0.0
+   * @category mutations
+   */
   (n: number): (self: TSemaphore) => STM.STM<void>
+  /**
+   * @since 2.0.0
+   * @category mutations
+   */
   (self: TSemaphore, n: number): STM.STM<void>
 } = internal.releaseN
 
@@ -94,7 +110,15 @@ export const releaseN: {
  * @category mutations
  */
 export const withPermit: {
+  /**
+   * @since 2.0.0
+   * @category mutations
+   */
   (semaphore: TSemaphore): <A, E, R>(self: Effect.Effect<A, E, R>) => Effect.Effect<A, E, R>
+  /**
+   * @since 2.0.0
+   * @category mutations
+   */
   <A, E, R>(self: Effect.Effect<A, E, R>, semaphore: TSemaphore): Effect.Effect<A, E, R>
 } = internal.withPermit
 
@@ -103,7 +127,15 @@ export const withPermit: {
  * @category mutations
  */
 export const withPermits: {
+  /**
+   * @since 2.0.0
+   * @category mutations
+   */
   (semaphore: TSemaphore, permits: number): <A, E, R>(self: Effect.Effect<A, E, R>) => Effect.Effect<A, E, R>
+  /**
+   * @since 2.0.0
+   * @category mutations
+   */
   <A, E, R>(self: Effect.Effect<A, E, R>, semaphore: TSemaphore, permits: number): Effect.Effect<A, E, R>
 } = internal.withPermits
 
@@ -118,7 +150,15 @@ export const withPermitScoped: (self: TSemaphore) => Effect.Effect<void, never,
  * @category mutations
  */
 export const withPermitsScoped: {
+  /**
+   * @since 2.0.0
+   * @category mutations
+   */
   (permits: number): (self: TSemaphore) => Effect.Effect<void, never, Scope.Scope>
+  /**
+   * @since 2.0.0
+   * @category mutations
+   */
   (self: TSemaphore, permits: number): Effect.Effect<void, never, Scope.Scope>
 } = internal.withPermitsScoped