effect 4.0.0-beta.67 → 4.0.0-beta.68

package/src/TxRef.ts

@@ -44,7 +44,7 @@ const TypeId = "~effect/transactions/TxRef"
  * })
  * ```
  *
- * @category Models
+ * @category models
  * @since 4.0.0
  */
 export interface TxRef<in out A> extends Pipeable {
@@ -79,8 +79,8 @@ export interface TxRef<in out A> extends Pipeable {
  * })
  * ```
  *
- * @category Constructors
- * @since 4.0.0
+ * @category constructors
+ * @since 2.0.0
  */
 export const make = <A>(initial: A) => Effect.sync(() => makeUnsafe(initial))
 
@@ -104,7 +104,7 @@ export const make = <A>(initial: A) => Effect.sync(() => makeUnsafe(initial))
  * console.log(config.value) // { timeout: 5000, retries: 3 }
  * ```
  *
- * @category Constructors
+ * @category constructors
  * @since 4.0.0
  */
 export const makeUnsafe = <A>(initial: A): TxRef<A> => ({
@@ -136,8 +136,8 @@ export const makeUnsafe = <A>(initial: A): TxRef<A> => ({
  * })
  * ```
  *
- * @category Combinators
- * @since 4.0.0
+ * @category combinators
+ * @since 2.0.0
  */
 export const modify: {
   /**
@@ -159,8 +159,8 @@ export const modify: {
    * })
    * ```
    *
-   * @category Combinators
-   * @since 4.0.0
+   * @category combinators
+   * @since 2.0.0
    */
   <A, R>(f: (current: NoInfer<A>) => [returnValue: R, newValue: A]): (self: TxRef<A>) => Effect.Effect<R>
   /**
@@ -182,8 +182,8 @@ export const modify: {
    * })
    * ```
    *
-   * @category Combinators
-   * @since 4.0.0
+   * @category combinators
+   * @since 2.0.0
    */
   <A, R>(self: TxRef<A>, f: (current: A) => [returnValue: R, newValue: A]): Effect.Effect<R>
 } = dual(2, <A, R>(
@@ -225,8 +225,8 @@ export const modify: {
  * })
  * ```
  *
- * @category Combinators
- * @since 4.0.0
+ * @category combinators
+ * @since 2.0.0
  */
 export const update: {
   /**
@@ -249,8 +249,8 @@ export const update: {
    * })
    * ```
    *
-   * @category Combinators
-   * @since 4.0.0
+   * @category combinators
+   * @since 2.0.0
    */
   <A>(f: (current: NoInfer<A>) => A): (self: TxRef<A>) => Effect.Effect<void>
   /**
@@ -273,8 +273,8 @@ export const update: {
    * })
    * ```
    *
-   * @category Combinators
-   * @since 4.0.0
+   * @category combinators
+   * @since 2.0.0
    */
   <A>(self: TxRef<A>, f: (current: A) => A): Effect.Effect<void>
 } = dual(2, <A>(
@@ -302,8 +302,8 @@ export const update: {
  * })
  * ```
  *
- * @category Combinators
- * @since 4.0.0
+ * @category combinators
+ * @since 2.0.0
  */
 export const get = <A>(self: TxRef<A>): Effect.Effect<A> => modify(self, (current) => [current, current])
 
@@ -327,8 +327,8 @@ export const get = <A>(self: TxRef<A>): Effect.Effect<A> => modify(self, (curren
  * })
  * ```
  *
- * @category Combinators
- * @since 4.0.0
+ * @category combinators
+ * @since 2.0.0
  */
 export const set: {
   /**
@@ -351,8 +351,8 @@ export const set: {
    * })
    * ```
    *
-   * @category Combinators
-   * @since 4.0.0
+   * @category combinators
+   * @since 2.0.0
    */
   <A>(value: A): (self: TxRef<A>) => Effect.Effect<void>
   /**
@@ -375,8 +375,8 @@ export const set: {
    * })
    * ```
    *
-   * @category Combinators
-   * @since 4.0.0
+   * @category combinators
+   * @since 2.0.0
    */
   <A>(self: TxRef<A>, value: A): Effect.Effect<void>
 } = dual(2, <A>(

package/src/TxSemaphore.ts

@@ -114,12 +114,8 @@ const makeTxSemaphore = (permitsRef: TxRef.TxRef<number>, capacity: number): TxS
  * })
  * ```
  *
- * @param permits - The initial number of permits (must be non-negative)
- * @returns Effect that succeeds with a new TxSemaphore
- * @throws Defect if permits is negative
- *
  * @category constructors
- * @since 4.0.0
+ * @since 2.0.0
  */
 export const make = (permits: number): Effect.Effect<TxSemaphore> =>
   Effect.gen(function*() {
@@ -156,11 +152,8 @@ export const make = (permits: number): Effect.Effect<TxSemaphore> =>
  * })
  * ```
  *
- * @param self - The TxSemaphore to inspect
- * @returns Effect that succeeds with the current number of available permits
- *
  * @category combinators
- * @since 4.0.0
+ * @since 2.0.0
  */
 export const available = (self: TxSemaphore): Effect.Effect<number> => TxRef.get(self.permitsRef)
 
@@ -185,9 +178,6 @@ export const available = (self: TxSemaphore): Effect.Effect<number> => TxRef.get
  * })
  * ```
  *
- * @param self - The TxSemaphore to inspect
- * @returns Effect that succeeds with the semaphore's maximum capacity
- *
  * @category combinators
  * @since 4.0.0
  */
@@ -218,11 +208,8 @@ export const capacity = (self: TxSemaphore): Effect.Effect<number> => Effect.suc
  * })
  * ```
  *
- * @param self - The TxSemaphore from which to acquire a permit
- * @returns Effect that succeeds when a permit is acquired
- *
  * @category combinators
- * @since 4.0.0
+ * @since 2.0.0
  */
 export const acquire = (self: TxSemaphore): Effect.Effect<void> =>
   Effect.gen(function*() {
@@ -258,12 +245,8 @@ export const acquire = (self: TxSemaphore): Effect.Effect<void> =>
  * })
  * ```
  *
- * @param self - The TxSemaphore from which to acquire permits
- * @param n - The number of permits to acquire (must be positive)
- * @returns Effect that succeeds when the permits are acquired
- *
  * @category combinators
- * @since 4.0.0
+ * @since 2.0.0
  */
 export const acquireN = (self: TxSemaphore, n: number): Effect.Effect<void> => {
   if (n <= 0) {
@@ -300,9 +283,6 @@ export const acquireN = (self: TxSemaphore, n: number): Effect.Effect<void> => {
  * })
  * ```
  *
- * @param self - The TxSemaphore from which to try acquiring a permit
- * @returns Effect that succeeds with true if permit acquired, false otherwise
- *
  * @category combinators
  * @since 4.0.0
  */
@@ -336,10 +316,6 @@ export const tryAcquire = (self: TxSemaphore): Effect.Effect<boolean> =>
  * })
  * ```
  *
- * @param self - The TxSemaphore from which to try acquiring permits
- * @param n - The number of permits to try acquiring (must be positive)
- * @returns Effect that succeeds with true if permits acquired, false otherwise
- *
  * @category combinators
  * @since 4.0.0
  */
@@ -382,11 +358,8 @@ export const tryAcquireN = (self: TxSemaphore, n: number): Effect.Effect<boolean
  * })
  * ```
  *
- * @param self - The TxSemaphore to which to release a permit
- * @returns Effect that succeeds when the permit is released
- *
  * @category combinators
- * @since 4.0.0
+ * @since 2.0.0
  */
 export const release = (self: TxSemaphore): Effect.Effect<void> =>
   TxRef.update(self.permitsRef, (permits: number) => permits >= self.capacity ? permits : permits + 1)
@@ -417,12 +390,8 @@ export const release = (self: TxSemaphore): Effect.Effect<void> =>
  * })
  * ```
  *
- * @param self - The TxSemaphore to which to release permits
- * @param n - The number of permits to release (must be positive)
- * @returns Effect that succeeds when the permits are released
- *
  * @category combinators
- * @since 4.0.0
+ * @since 2.0.0
  */
 export const releaseN = (self: TxSemaphore, n: number): Effect.Effect<void> => {
   if (n <= 0) {
@@ -466,12 +435,8 @@ export const releaseN = (self: TxSemaphore, n: number): Effect.Effect<void> => {
  * })
  * ```
  *
- * @param self - The TxSemaphore to acquire a permit from
- * @param effect - The effect to execute with the permit
- * @returns Effect that succeeds with the result of the provided effect
- *
  * @category combinators
- * @since 4.0.0
+ * @since 2.0.0
  */
 export const withPermit: {
   /**
@@ -506,12 +471,8 @@ export const withPermit: {
    * })
    * ```
    *
-   * @param self - The TxSemaphore to acquire a permit from
-   * @param effect - The effect to execute with the permit
-   * @returns Effect that succeeds with the result of the provided effect
-   *
    * @category combinators
-   * @since 4.0.0
+   * @since 2.0.0
    */
   (self: TxSemaphore): <A, E, R>(effect: Effect.Effect<A, E, R>) => Effect.Effect<A, E, R>
   /**
@@ -546,12 +507,8 @@ export const withPermit: {
    * })
    * ```
    *
-   * @param self - The TxSemaphore to acquire a permit from
-   * @param effect - The effect to execute with the permit
-   * @returns Effect that succeeds with the result of the provided effect
-   *
    * @category combinators
-   * @since 4.0.0
+   * @since 2.0.0
    */
   <A, E, R>(self: TxSemaphore, effect: Effect.Effect<A, E, R>): Effect.Effect<A, E, R>
 } = ((...args: Array<any>) => {
@@ -604,13 +561,8 @@ export const withPermit: {
  * })
  * ```
  *
- * @param self - The TxSemaphore to acquire permits from
- * @param n - The number of permits to acquire (must be positive)
- * @param effect - The effect to execute with the permits
- * @returns Effect that succeeds with the result of the provided effect
- *
  * @category combinators
- * @since 4.0.0
+ * @since 2.0.0
  */
 export const withPermits: {
   /**
@@ -645,13 +597,8 @@ export const withPermits: {
    * })
    * ```
    *
-   * @param self - The TxSemaphore to acquire permits from
-   * @param n - The number of permits to acquire (must be positive)
-   * @param effect - The effect to execute with the permits
-   * @returns Effect that succeeds with the result of the provided effect
-   *
    * @category combinators
-   * @since 4.0.0
+   * @since 2.0.0
    */
   (self: TxSemaphore, n: number): <A, E, R>(effect: Effect.Effect<A, E, R>) => Effect.Effect<A, E, R>
   /**
@@ -686,13 +633,8 @@ export const withPermits: {
    * })
    * ```
    *
-   * @param self - The TxSemaphore to acquire permits from
-   * @param n - The number of permits to acquire (must be positive)
-   * @param effect - The effect to execute with the permits
-   * @returns Effect that succeeds with the result of the provided effect
-   *
    * @category combinators
-   * @since 4.0.0
+   * @since 2.0.0
    */
   <A, E, R>(self: TxSemaphore, n: number, effect: Effect.Effect<A, E, R>): Effect.Effect<A, E, R>
 } = ((...args: Array<any>) => {
@@ -747,11 +689,8 @@ export const withPermits: {
  * })
  * ```
  *
- * @param self - The TxSemaphore to acquire a permit from
- * @returns Effect that succeeds when the permit is acquired (within scope)
- *
  * @category combinators
- * @since 4.0.0
+ * @since 2.0.0
  */
 export const withPermitScoped = (self: TxSemaphore): Effect.Effect<void, never, Scope.Scope> =>
   Effect.acquireRelease(

package/src/TxSubscriptionRef.ts

@@ -27,7 +27,7 @@ const TypeId = "~effect/transactions/TxSubscriptionRef"
  * **Example** (Subscribing to transactional changes)
  *
  * ```ts
- * import { Effect, TxSubscriptionRef, TxQueue } from "effect"
+ * import { Effect, TxQueue, TxSubscriptionRef } from "effect"
  *
  * const program = Effect.gen(function*() {
  *   const ref = yield* TxSubscriptionRef.make(0)
@@ -92,7 +92,7 @@ const TxSubscriptionRefProto: Omit<TxSubscriptionRef<any>, typeof TypeId | "ref"
  * ```
  *
  * @category constructors
- * @since 4.0.0
+ * @since 3.10.0
  */
 export const make = <A>(value: A): Effect.Effect<TxSubscriptionRef<A>> =>
   Effect.gen(function*() {
@@ -125,7 +125,7 @@ export const make = <A>(value: A): Effect.Effect<TxSubscriptionRef<A>> =>
  * ```
  *
  * @category getters
- * @since 4.0.0
+ * @since 3.10.0
  */
 export const get = <A>(self: TxSubscriptionRef<A>): Effect.Effect<A> => TxRef.get(self.ref)
 
@@ -151,7 +151,7 @@ export const get = <A>(self: TxSubscriptionRef<A>): Effect.Effect<A> => TxRef.ge
  * ```
  *
  * @category mutations
- * @since 4.0.0
+ * @since 3.10.0
  */
 export const modify: {
   // =============================================================================
@@ -176,7 +176,7 @@ export const modify: {
    * ```
    *
    * @category mutations
-   * @since 4.0.0
+   * @since 3.10.0
    */
   <A, B>(f: (current: A) => [returnValue: B, newValue: A]): (self: TxSubscriptionRef<A>) => Effect.Effect<B>
   // =============================================================================
@@ -201,7 +201,7 @@ export const modify: {
    * ```
    *
    * @category mutations
-   * @since 4.0.0
+   * @since 3.10.0
    */
   <A, B>(
     self: TxSubscriptionRef<A>,
@@ -238,7 +238,7 @@ export const modify: {
  * ```
  *
  * @category mutations
- * @since 4.0.0
+ * @since 3.10.0
  */
 export const set: {
   /**
@@ -257,7 +257,7 @@ export const set: {
    * ```
    *
    * @category mutations
-   * @since 4.0.0
+   * @since 3.10.0
    */
   <A>(value: A): (self: TxSubscriptionRef<A>) => Effect.Effect<void>
   /**
@@ -276,7 +276,7 @@ export const set: {
    * ```
    *
    * @category mutations
-   * @since 4.0.0
+   * @since 3.10.0
    */
   <A>(self: TxSubscriptionRef<A>, value: A): Effect.Effect<void>
 } = dual(
@@ -301,7 +301,7 @@ export const set: {
  * ```
  *
  * @category mutations
- * @since 4.0.0
+ * @since 3.10.0
  */
 export const update: {
   /**
@@ -321,7 +321,7 @@ export const update: {
    * ```
    *
    * @category mutations
-   * @since 4.0.0
+   * @since 3.10.0
    */
   <A>(f: (current: A) => A): (self: TxSubscriptionRef<A>) => Effect.Effect<void>
   /**
@@ -341,7 +341,7 @@ export const update: {
    * ```
    *
    * @category mutations
-   * @since 4.0.0
+   * @since 3.10.0
    */
   <A>(self: TxSubscriptionRef<A>, f: (current: A) => A): Effect.Effect<void>
 } = dual(
@@ -368,7 +368,7 @@ export const update: {
  * ```
  *
  * @category mutations
- * @since 4.0.0
+ * @since 3.10.0
  */
 export const getAndSet: {
   /**
@@ -389,7 +389,7 @@ export const getAndSet: {
    * ```
    *
    * @category mutations
-   * @since 4.0.0
+   * @since 3.10.0
    */
   <A>(value: A): (self: TxSubscriptionRef<A>) => Effect.Effect<A>
   /**
@@ -410,7 +410,7 @@ export const getAndSet: {
    * ```
    *
    * @category mutations
-   * @since 4.0.0
+   * @since 3.10.0
    */
   <A>(self: TxSubscriptionRef<A>, value: A): Effect.Effect<A>
 } = dual(
@@ -436,7 +436,7 @@ export const getAndSet: {
  * ```
  *
  * @category mutations
- * @since 4.0.0
+ * @since 3.10.0
  */
 export const getAndUpdate: {
   /**
@@ -457,7 +457,7 @@ export const getAndUpdate: {
    * ```
    *
    * @category mutations
-   * @since 4.0.0
+   * @since 3.10.0
    */
   <A>(f: (current: A) => A): (self: TxSubscriptionRef<A>) => Effect.Effect<A>
   /**
@@ -478,7 +478,7 @@ export const getAndUpdate: {
    * ```
    *
    * @category mutations
-   * @since 4.0.0
+   * @since 3.10.0
    */
   <A>(self: TxSubscriptionRef<A>, f: (current: A) => A): Effect.Effect<A>
 } = dual(
@@ -504,7 +504,7 @@ export const getAndUpdate: {
  * ```
  *
  * @category mutations
- * @since 4.0.0
+ * @since 3.10.0
  */
 export const updateAndGet: {
   /**
@@ -524,7 +524,7 @@ export const updateAndGet: {
    * ```
    *
    * @category mutations
-   * @since 4.0.0
+   * @since 3.10.0
    */
   <A>(f: (current: A) => A): (self: TxSubscriptionRef<A>) => Effect.Effect<A>
   /**
@@ -544,7 +544,7 @@ export const updateAndGet: {
    * ```
    *
    * @category mutations
-   * @since 4.0.0
+   * @since 3.10.0
    */
   <A>(self: TxSubscriptionRef<A>, f: (current: A) => A): Effect.Effect<A>
 } = dual(
@@ -567,7 +567,7 @@ export const updateAndGet: {
  * **Example** (Subscribing to changes)
  *
  * ```ts
- * import { Effect, TxSubscriptionRef, TxQueue } from "effect"
+ * import { Effect, TxQueue, TxSubscriptionRef } from "effect"
  *
  * const program = Effect.gen(function*() {
  *   const ref = yield* TxSubscriptionRef.make(0)
@@ -587,7 +587,7 @@ export const updateAndGet: {
  * ```
  *
  * @category subscriptions
- * @since 4.0.0
+ * @since 3.10.0
  */
 export const changes = <A>(
   self: TxSubscriptionRef<A>
@@ -626,7 +626,7 @@ export const changes = <A>(
  * ```
  *
  * @category subscriptions
- * @since 4.0.0
+ * @since 3.10.0
  */
 export const changesStream = <A>(self: TxSubscriptionRef<A>): Stream.Stream<A, never, never> =>
   Stream.unwrap(

package/src/Types.ts

@@ -571,7 +571,6 @@ export type Invariant<A> = (_: A) => A
 /**
  * Namespace for {@link Invariant}-related utilities.
  *
- * @category models
  * @since 3.9.0
  */
 export declare namespace Invariant {
@@ -627,7 +626,6 @@ export type Covariant<A> = (_: never) => A
 /**
  * Namespace for {@link Covariant}-related utilities.
  *
- * @category models
  * @since 3.9.0
  */
 export declare namespace Covariant {
@@ -683,7 +681,6 @@ export type Contravariant<A> = (_: A) => void
 /**
  * Namespace for {@link Contravariant}-related utilities.
  *
- * @category models
  * @since 3.9.0
  */
 export declare namespace Contravariant {
@@ -712,7 +709,7 @@ export declare namespace Contravariant {
  * otherwise returns `S`.
  *
  * @category types
- * @since 4.0.0
+ * @since 3.19.20
  */
 export type VoidIfEmpty<S> = keyof S extends never ? void : S
 

package/src/UndefinedOr.ts

@@ -35,18 +35,21 @@ import * as Reducer from "./Reducer.ts"
 /**
  * Maps a defined value with `f`, or returns `undefined` unchanged.
  *
+ * @category mapping
  * @since 4.0.0
  */
 export const map: {
   /**
    * Maps a defined value with `f`, or returns `undefined` unchanged.
    *
+   * @category mapping
    * @since 4.0.0
    */
   <A, B>(f: (a: A) => B): (self: A | undefined) => B | undefined
   /**
    * Maps a defined value with `f`, or returns `undefined` unchanged.
    *
+   * @category mapping
    * @since 4.0.0
    */
   <A, B>(self: A | undefined, f: (a: A) => B): B | undefined
@@ -58,6 +61,7 @@ export const map: {
  * Runs `onDefined` with the value when it is present, or evaluates
  * `onUndefined` when the value is `undefined`.
  *
+ * @category pattern matching
  * @since 4.0.0
  */
 export const match: {
@@ -67,6 +71,7 @@ export const match: {
    * Runs `onDefined` with the value when it is present, or evaluates
    * `onUndefined` when the value is `undefined`.
    *
+   * @category pattern matching
    * @since 4.0.0
    */
   <B, A, C = B>(
@@ -81,6 +86,7 @@ export const match: {
    * Runs `onDefined` with the value when it is present, or evaluates
    * `onUndefined` when the value is `undefined`.
    *
+   * @category pattern matching
    * @since 4.0.0
    */
   <A, B, C = B>(
@@ -102,6 +108,7 @@ export const match: {
  * Returns the defined value, or throws the value produced by `onUndefined`
  * when the input is `undefined`.
  *
+ * @category getters
  * @since 4.0.0
  */
 export const getOrThrowWith: {
@@ -109,6 +116,7 @@ export const getOrThrowWith: {
    * Returns the defined value, or throws the value produced by `onUndefined`
    * when the input is `undefined`.
    *
+   * @category getters
    * @since 4.0.0
    */
   (onUndefined: () => unknown): <A>(self: A | undefined) => A
@@ -116,6 +124,7 @@ export const getOrThrowWith: {
    * Returns the defined value, or throws the value produced by `onUndefined`
    * when the input is `undefined`.
    *
+   * @category getters
    * @since 4.0.0
    */
   <A>(self: A | undefined, onUndefined: () => unknown): A
@@ -130,6 +139,7 @@ export const getOrThrowWith: {
  * Returns the defined value, or throws a default `Error` when the input is
  * `undefined`.
  *
+ * @category getters
  * @since 4.0.0
  */
 export const getOrThrow: <A>(self: A | undefined) => A = getOrThrowWith(() =>
@@ -143,6 +153,7 @@ export const getOrThrow: <A>(self: A | undefined) => A = getOrThrowWith(() =>
  * The returned function passes through successful results and discards thrown
  * errors by representing them as `undefined`.
  *
+ * @category converting
  * @since 4.0.0
  */
 export const liftThrowable = <A extends ReadonlyArray<unknown>, B>(
@@ -173,6 +184,7 @@ export const liftThrowable = <A extends ReadonlyArray<unknown>, B>(
  * - `undefined` + `b` = `b` (second value wins)
  * - `a` + `b` = `a + b` (values combined)
  *
+ * @category constructors
  * @since 4.0.0
  */
 export function makeReducer<A>(combiner: Combiner.Combiner<A>): Reducer.Reducer<A | undefined> {
@@ -193,6 +205,7 @@ export function makeReducer<A>(combiner: Combiner.Combiner<A>): Reducer.Reducer<
  * @see {@link makeReducerFailFast} if you have a `Reducer` and want to lift it
  * to `UndefinedOr` values.
  *
+ * @category constructors
  * @since 4.0.0
  */
 export function makeCombinerFailFast<A>(combiner: Combiner.Combiner<A>): Combiner.Combiner<A | undefined> {
@@ -213,6 +226,7 @@ export function makeCombinerFailFast<A>(combiner: Combiner.Combiner<A>): Combine
  * @see {@link makeCombinerFailFast} if you only have a `Combiner` and want to
  * lift it to `UndefinedOr` values.
  *
+ * @category constructors
  * @since 4.0.0
  */
 export function makeReducerFailFast<A>(reducer: Reducer.Reducer<A>): Reducer.Reducer<A | undefined> {