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

package/src/Cache.ts

@@ -125,8 +125,8 @@ const TypeId = "~effect/Cache"
  * })
  * ```
  *
- * @category Models
- * @since 4.0.0
+ * @category models
+ * @since 2.0.0
  */
 export interface Cache<in out Key, in out A, in out E = never, out R = never> extends Pipeable {
   readonly [TypeId]: typeof TypeId
@@ -146,7 +146,7 @@ export interface Cache<in out Key, in out A, in out E = never, out R = never> ex
  * users should interact with entries through the `Cache` combinators rather
  * than constructing them directly.
  *
- * @category Models
+ * @category models
  * @since 4.0.0
  */
 export interface Entry<A, E> {
@@ -185,8 +185,8 @@ export interface Entry<A, E> {
  * })
  * ```
  *
- * @category Constructors
- * @since 4.0.0
+ * @category constructors
+ * @since 2.0.0
  */
 export const makeWith = <
   Key,
@@ -277,8 +277,8 @@ export const makeWith = <
  * })
  * ```
  *
- * @category Constructors
- * @since 4.0.0
+ * @category constructors
+ * @since 2.0.0
  */
 export const make = <
   Key,
@@ -404,7 +404,7 @@ const defaultTimeToLive = <A, E>(_: Exit.Exit<A, E>, _key: unknown): Duration.Du
  * })
  * ```
  *
- * @category Combinators
+ * @category combinators
  * @since 4.0.0
  */
 export const get: {
@@ -495,7 +495,7 @@ export const get: {
    * })
    * ```
    *
-   * @category Combinators
+   * @category combinators
    * @since 4.0.0
    */
   <Key, A>(key: Key): <E, R>(self: Cache<Key, A, E, R>) => Effect.Effect<A, E, R>
@@ -586,7 +586,7 @@ export const get: {
    * })
    * ```
    *
-   * @category Combinators
+   * @category combinators
    * @since 4.0.0
    */
   <Key, A, E, R>(self: Cache<Key, A, E, R>, key: Key): Effect.Effect<A, E, R>
@@ -688,7 +688,7 @@ export const get: {
        * })
        * ```
        *
-       * @category Combinators
+       * @category combinators
        * @since 4.0.0
        */
       A, /**
@@ -778,7 +778,7 @@ export const get: {
        * })
        * ```
        *
-       * @category Combinators
+       * @category combinators
        * @since 4.0.0
        */
       E>()
@@ -917,7 +917,7 @@ const checkCapacity = <K, A, E, R>(self: Cache<K, A, E, R>) => {
  * })
  * ```
  *
- * @category Combinators
+ * @category combinators
  * @since 4.0.0
  */
 export const getOption: {
@@ -1017,7 +1017,7 @@ export const getOption: {
    * })
    * ```
    *
-   * @category Combinators
+   * @category combinators
    * @since 4.0.0
    */
   <Key, A>(key: Key): <E, R>(self: Cache<Key, A, E, R>) => Effect.Effect<Option.Option<A>, E>
@@ -1117,7 +1117,7 @@ export const getOption: {
    * })
    * ```
    *
-   * @category Combinators
+   * @category combinators
    * @since 4.0.0
    */
   <Key, A, E, R>(self: Cache<Key, A, E, R>, key: Key): Effect.Effect<Option.Option<A>, E>
@@ -1153,7 +1153,7 @@ const getImpl = <Key, A, E, R>(
  * Retrieves the value associated with the specified key from the cache, only if
  * it contains a resolved successful value.
  *
- * @category Combinators
+ * @category combinators
  * @since 4.0.0
  */
 export const getSuccess: {
@@ -1161,7 +1161,7 @@ export const getSuccess: {
    * Retrieves the value associated with the specified key from the cache, only if
    * it contains a resolved successful value.
    *
-   * @category Combinators
+   * @category combinators
    * @since 4.0.0
    */
   <Key, A, R>(key: Key): <E>(self: Cache<Key, A, E, R>) => Effect.Effect<Option.Option<A>>
@@ -1169,7 +1169,7 @@ export const getSuccess: {
    * Retrieves the value associated with the specified key from the cache, only if
    * it contains a resolved successful value.
    *
-   * @category Combinators
+   * @category combinators
    * @since 4.0.0
    */
   <Key, A, E, R>(self: Cache<Key, A, E, R>, key: Key): Effect.Effect<Option.Option<A>>
@@ -1279,7 +1279,7 @@ export const getSuccess: {
  * })
  * ```
  *
- * @category Combinators
+ * @category combinators
  * @since 4.0.0
  */
 export const set: {
@@ -1377,7 +1377,7 @@ export const set: {
    * })
    * ```
    *
-   * @category Combinators
+   * @category combinators
    * @since 4.0.0
    */
   <Key, A>(key: Key, value: A): <E, R>(self: Cache<Key, A, E, R>) => Effect.Effect<void>
@@ -1475,7 +1475,7 @@ export const set: {
    * })
    * ```
    *
-   * @category Combinators
+   * @category combinators
    * @since 4.0.0
    */
   <Key, A, E, R>(self: Cache<Key, A, E, R>, key: Key, value: A): Effect.Effect<void>
@@ -1578,7 +1578,7 @@ export const set: {
        * })
        * ```
        *
-       * @category Combinators
+       * @category combinators
        * @since 4.0.0
        */
       A, /**
@@ -1675,7 +1675,7 @@ export const set: {
        * })
        * ```
        *
-       * @category Combinators
+       * @category combinators
        * @since 4.0.0
        */
       E>()
@@ -1777,7 +1777,7 @@ export const set: {
  * })
  * ```
  *
- * @category Combinators
+ * @category combinators
  * @since 4.0.0
  */
 export const has: {
@@ -1862,7 +1862,7 @@ export const has: {
    * })
    * ```
    *
-   * @category Combinators
+   * @category combinators
    * @since 4.0.0
    */
   <Key, A>(key: Key): <E, R>(self: Cache<Key, A, E, R>) => Effect.Effect<boolean>
@@ -1947,7 +1947,7 @@ export const has: {
    * })
    * ```
    *
-   * @category Combinators
+   * @category combinators
    * @since 4.0.0
    */
   <Key, A, E, R>(self: Cache<Key, A, E, R>, key: Key): Effect.Effect<boolean>
@@ -2002,7 +2002,7 @@ export const has: {
  * })
  * ```
  *
- * @category Combinators
+ * @category combinators
  * @since 4.0.0
  */
 export const invalidate: {
@@ -2048,7 +2048,7 @@ export const invalidate: {
    * })
    * ```
    *
-   * @category Combinators
+   * @category combinators
    * @since 4.0.0
    */
   <Key, A>(key: Key): <E, R>(self: Cache<Key, A, E, R>) => Effect.Effect<void>
@@ -2094,7 +2094,7 @@ export const invalidate: {
    * })
    * ```
    *
-   * @category Combinators
+   * @category combinators
    * @since 4.0.0
    */
   <Key, A, E, R>(self: Cache<Key, A, E, R>, key: Key): Effect.Effect<void>
@@ -2165,7 +2165,7 @@ export const invalidate: {
  * })
  * ```
  *
- * @category Combinators
+ * @category combinators
  * @since 4.0.0
  */
 export const invalidateWhen: {
@@ -2231,7 +2231,7 @@ export const invalidateWhen: {
    * })
    * ```
    *
-   * @category Combinators
+   * @category combinators
    * @since 4.0.0
    */
   <Key, A>(key: Key, f: Predicate<A>): <E, R>(self: Cache<Key, A, E, R>) => Effect.Effect<boolean>
@@ -2297,7 +2297,7 @@ export const invalidateWhen: {
    * })
    * ```
    *
-   * @category Combinators
+   * @category combinators
    * @since 4.0.0
    */
   <Key, A, E, R>(self: Cache<Key, A, E, R>, key: Key, f: Predicate<A>): Effect.Effect<boolean>
@@ -2409,7 +2409,7 @@ export const invalidateWhen: {
  * })
  * ```
  *
- * @category Combinators
+ * @category combinators
  * @since 4.0.0
  */
 export const refresh: {
@@ -2500,7 +2500,7 @@ export const refresh: {
    * })
    * ```
    *
-   * @category Combinators
+   * @category combinators
    * @since 4.0.0
    */
   <Key, A>(key: Key): <E, R>(self: Cache<Key, A, E, R>) => Effect.Effect<A, E, R>
@@ -2591,7 +2591,7 @@ export const refresh: {
    * })
    * ```
    *
-   * @category Combinators
+   * @category combinators
    * @since 4.0.0
    */
   <Key, A, E, R>(self: Cache<Key, A, E, R>, key: Key): Effect.Effect<A, E, R>
@@ -2686,7 +2686,7 @@ export const refresh: {
        * })
        * ```
        *
-       * @category Combinators
+       * @category combinators
        * @since 4.0.0
        */
       A, /**
@@ -2776,7 +2776,7 @@ export const refresh: {
        * })
        * ```
        *
-       * @category Combinators
+       * @category combinators
        * @since 4.0.0
        */
       E>()
@@ -2841,7 +2841,7 @@ export const refresh: {
  * })
  * ```
  *
- * @category Combinators
+ * @category combinators
  * @since 4.0.0
  */
 export const invalidateAll = <Key, A, E, R>(self: Cache<Key, A, E, R>): Effect.Effect<void> =>
@@ -2884,7 +2884,7 @@ export const invalidateAll = <Key, A, E, R>(self: Cache<Key, A, E, R>): Effect.E
  * })
  * ```
  *
- * @category Combinators
+ * @category combinators
  * @since 4.0.0
  */
 export const size = <Key, A, E, R>(self: Cache<Key, A, E, R>): Effect.Effect<number> =>
@@ -2917,7 +2917,7 @@ export const size = <Key, A, E, R>(self: Cache<Key, A, E, R>): Effect.Effect<num
  * })
  * ```
  *
- * @category Combinators
+ * @category combinators
  * @since 4.0.0
  */
 export const keys = <Key, A, E, R>(self: Cache<Key, A, E, R>): Effect.Effect<Iterable<Key>> =>
@@ -2960,7 +2960,7 @@ export const keys = <Key, A, E, R>(self: Cache<Key, A, E, R>): Effect.Effect<Ite
  * })
  * ```
  *
- * @category Combinators
+ * @category combinators
  * @since 4.0.0
  */
 export const values = <Key, A, E, R>(self: Cache<Key, A, E, R>): Effect.Effect<Iterable<A>> =>
@@ -2971,7 +2971,7 @@ export const values = <Key, A, E, R>(self: Cache<Key, A, E, R>): Effect.Effect<I
  * only returns entries with successfully resolved values, filtering out any
  * failed lookups or expired entries.
  *
- * @category Combinators
+ * @category combinators
  * @since 4.0.0
  */
 export const entries = <Key, A, E, R>(self: Cache<Key, A, E, R>): Effect.Effect<Iterable<[Key, A]>> =>

package/src/Cause.ts

@@ -94,7 +94,7 @@ import type * as Types from "./Types.ts"
  * Unique brand for `Cause` values, used for runtime type checks via {@link isCause}.
  *
  * @category symbols
- * @since 2.0.0
+ * @since 4.0.0
  */
 export const TypeId: "~effect/Cause" = core.CauseTypeId
 
@@ -102,7 +102,7 @@ export const TypeId: "~effect/Cause" = core.CauseTypeId
  * Unique brand for `Reason` values, used for runtime type checks via {@link isReason}.
  *
  * @category symbols
- * @since 2.0.0
+ * @since 4.0.0
  */
 export const ReasonTypeId: "~effect/Cause/Reason" = core.CauseReasonTypeId
 
@@ -173,7 +173,7 @@ export const isCause: (self: unknown) => self is Cause<unknown> = core.isCause
  * ```
  *
  * @category guards
- * @since 2.0.0
+ * @since 4.0.0
  */
 export const isReason: (self: unknown) => self is Reason<unknown> = core.isCauseReason
 
@@ -282,7 +282,6 @@ export const isInterruptReason: <E>(self: Reason<E>) => self is Interrupt = core
 /**
  * Companion namespace for the {@link Cause} interface.
  *
- * @category models
  * @since 2.0.0
  */
 export declare namespace Cause {
@@ -328,8 +327,7 @@ export declare namespace Cause {
 /**
  * Companion namespace for the {@link Reason} type.
  *
- * @category models
- * @since 2.0.0
+ * @since 4.0.0
  */
 export declare namespace Reason {
   /**
@@ -461,7 +459,7 @@ export interface Interrupt extends Cause.ReasonProto<"Interrupt"> {
  * @see {@link combine} — merge two existing causes
  *
  * @category constructors
- * @since 2.0.0
+ * @since 4.0.0
  */
 export const fromReasons: <E>(
   reasons: ReadonlyArray<Reason<E>>
@@ -632,7 +630,7 @@ export const makeInterruptReason: (fiberId?: number | undefined) => Interrupt =
  * @see {@link hasInterrupts} — `true` if the cause contains *any* interrupts
  *
  * @category predicates
- * @since 2.0.0
+ * @since 4.0.0
  */
 export const hasInterruptsOnly: <E>(self: Cause<E>) => boolean = effect.hasInterruptsOnly
 
@@ -657,7 +655,7 @@ export const hasInterruptsOnly: <E>(self: Cause<E>) => boolean = effect.hasInter
  * ```
  *
  * @category mapping
- * @since 4.0.0
+ * @since 2.0.0
  */
 export const map: {
   /**
@@ -681,7 +679,7 @@ export const map: {
    * ```
    *
    * @category mapping
-   * @since 4.0.0
+   * @since 2.0.0
    */
   <E, E2>(f: (error: Types.NoInfer<E>) => E2): (self: Cause<E>) => Cause<E2>
   /**
@@ -705,7 +703,7 @@ export const map: {
    * ```
    *
    * @category mapping
-   * @since 4.0.0
+   * @since 2.0.0
    */
   <E, E2>(self: Cause<E>, f: (error: Types.NoInfer<E>) => E2): Cause<E2>
 } = effect.causeMap
@@ -833,7 +831,7 @@ export const squash: <E>(self: Cause<E>) => unknown = effect.causeSquash
  * @see {@link hasInterrupts} — check for interruptions
  *
  * @category predicates
- * @since 2.0.0
+ * @since 4.0.0
  */
 export const hasFails: <E>(self: Cause<E>) => boolean = effect.hasFails
 
@@ -934,7 +932,7 @@ export const findErrorOption: <E>(input: Cause<E>) => Option<E> = effect.findErr
  * @see {@link hasInterrupts} — check for interruptions
  *
  * @category predicates
- * @since 2.0.0
+ * @since 4.0.0
  */
 export const hasDies: <E>(self: Cause<E>) => boolean = effect.hasDies
 
@@ -1008,7 +1006,7 @@ export const findDefect: <E>(self: Cause<E>) => Result.Result<unknown, Cause<E>>
  * @see {@link hasDies} — check for defects
  *
  * @category predicates
- * @since 2.0.0
+ * @since 4.0.0
  */
 export const hasInterrupts: <E>(self: Cause<E>) => boolean = effect.hasInterrupts
 
@@ -1059,7 +1057,7 @@ export const findInterrupt: <E>(self: Cause<E>) => Result.Result<Interrupt, Caus
  * @see {@link filterInterruptors} — `Filter`-based variant
  *
  * @category accessors
- * @since 4.0.0
+ * @since 2.0.0
  */
 export const interruptors: <E>(self: Cause<E>) => ReadonlySet<number> = effect.causeInterruptors
 
@@ -1122,7 +1120,7 @@ export const filterInterruptors: <E>(self: Cause<E>) => Result.Result<Set<number
  * @see {@link squash} — lossy collapse to a single thrown value
  *
  * @category rendering
- * @since 4.0.0
+ * @since 3.2.0
  */
 export const prettyErrors: <E>(self: Cause<E>) => Array<Error> = effect.causePrettyErrors
 
@@ -1159,7 +1157,7 @@ export const prettyErrors: <E>(self: Cause<E>) => Array<Error> = effect.causePre
  * @see {@link prettyErrors} — get the individual `Error` instances
  *
  * @category rendering
- * @since 4.0.0
+ * @since 2.0.0
  */
 export const pretty: <E>(cause: Cause<E>) => string = effect.causePretty
 
@@ -1331,7 +1329,6 @@ export interface Done<A = void> {
 /**
  * Companion namespace for the {@link Done} interface.
  *
- * @category errors
  * @since 4.0.0
  */
 export declare namespace Done {
@@ -1339,6 +1336,7 @@ export declare namespace Done {
    * Extracts the value type `A` from a `Done<A>` that may be nested in an
    * error union.
    *
+   * @category utility types
    * @since 4.0.0
    */
   export type Extract<E> = E extends Done<infer L> ? L : never
@@ -1346,6 +1344,7 @@ export declare namespace Done {
   /**
    * Filters a type union to only keep `Done` members.
    *
+   * @category filtering
    * @since 4.0.0
    */
   export type Only<E> = E extends Done<infer L> ? Done<L> : never