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

package/src/ScopedCache.ts

@@ -53,8 +53,8 @@ const TypeId = "~effect/ScopedCache"
  * exceeded, and release their entry scopes when invalidated, evicted, expired,
  * or when the cache's owning scope closes.
  *
- * @category Models
- * @since 4.0.0
+ * @category models
+ * @since 2.0.0
  */
 export interface ScopedCache<in out Key, in out A, in out E = never, out R = never> extends Pipeable {
   readonly [TypeId]: typeof TypeId
@@ -71,7 +71,7 @@ export interface ScopedCache<in out Key, in out A, in out E = never, out R = nev
  * `Closed` means the owning scope has closed and the cache can no longer
  * perform lookup operations.
  *
- * @category Models
+ * @category models
  * @since 4.0.0
  */
 export type State<K, A, E> = {
@@ -88,7 +88,7 @@ export type State<K, A, E> = {
  * that owns resources acquired while computing the value, and an optional
  * expiration time in milliseconds. Removing the entry closes its scope.
  *
- * @category Models
+ * @category models
  * @since 4.0.0
  */
 export interface Entry<A, E> {
@@ -107,8 +107,8 @@ export interface Entry<A, E> {
  * `requireServicesAt` controls whether lookup services are captured at
  * construction time or required when lookup operations run.
  *
- * @category Constructors
- * @since 4.0.0
+ * @category constructors
+ * @since 2.0.0
  */
 export const makeWith = <
   Key,
@@ -160,8 +160,8 @@ export const makeWith = <
  * entry scopes are closed when entries expire, are invalidated, are evicted, or
  * when the cache's owning scope closes.
  *
- * @category Constructors
- * @since 4.0.0
+ * @category constructors
+ * @since 2.0.0
  */
 export const make = <
   Key,
@@ -208,7 +208,7 @@ const defaultTimeToLive = <A, E>(_: Exit.Exit<A, E>, _key: unknown): Duration.Du
  * Successful and failed lookup exits are cached according to the configured
  * TTL. If the cache is closed, the effect is interrupted.
  *
- * @category Combinators
+ * @category combinators
  * @since 4.0.0
  */
 export const get: {
@@ -220,7 +220,7 @@ export const get: {
    * Successful and failed lookup exits are cached according to the configured
    * TTL. If the cache is closed, the effect is interrupted.
    *
-   * @category Combinators
+   * @category combinators
    * @since 4.0.0
    */
   <Key, A>(key: Key): <E, R>(self: ScopedCache<Key, A, E, R>) => Effect.Effect<A, E, R>
@@ -232,7 +232,7 @@ export const get: {
    * Successful and failed lookup exits are cached according to the configured
    * TTL. If the cache is closed, the effect is interrupted.
    *
-   * @category Combinators
+   * @category combinators
    * @since 4.0.0
    */
   <Key, A, E, R>(self: ScopedCache<Key, A, E, R>, key: Key): Effect.Effect<A, E, R>
@@ -261,7 +261,7 @@ export const get: {
          * Successful and failed lookup exits are cached according to the configured
          * TTL. If the cache is closed, the effect is interrupted.
          *
-         * @category Combinators
+         * @category combinators
          * @since 4.0.0
          */
         A, /**
@@ -272,7 +272,7 @@ export const get: {
          * Successful and failed lookup exits are cached according to the configured
          * TTL. If the cache is closed, the effect is interrupted.
          *
-         * @category Combinators
+         * @category combinators
          * @since 4.0.0
          */
         E>()
@@ -331,7 +331,7 @@ const checkCapacity = <K, A, E>(
  * the effect waits for its cached result and returns `Option.some(value)` on
  * success, or fails with the cached lookup error.
  *
- * @category Combinators
+ * @category combinators
  * @since 4.0.0
  */
 export const getOption: {
@@ -342,7 +342,7 @@ export const getOption: {
    * the effect waits for its cached result and returns `Option.some(value)` on
    * success, or fails with the cached lookup error.
    *
-   * @category Combinators
+   * @category combinators
    * @since 4.0.0
    */
   <Key, A>(key: Key): <E, R>(self: ScopedCache<Key, A, E, R>) => Effect.Effect<Option.Option<A>, E>
@@ -353,7 +353,7 @@ export const getOption: {
    * the effect waits for its cached result and returns `Option.some(value)` on
    * success, or fails with the cached lookup error.
    *
-   * @category Combinators
+   * @category combinators
    * @since 4.0.0
    */
   <Key, A, E, R>(self: ScopedCache<Key, A, E, R>, key: Key): Effect.Effect<Option.Option<A>, E>
@@ -400,7 +400,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: {
@@ -408,7 +408,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: ScopedCache<Key, A, E, R>) => Effect.Effect<Option.Option<A>>
@@ -416,7 +416,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: ScopedCache<Key, A, E, R>, key: Key): Effect.Effect<Option.Option<A>>
@@ -446,7 +446,7 @@ export const getSuccess: {
  * cache's TTL using a successful exit for the value, and may evict older
  * entries if the cache capacity is exceeded.
  *
- * @category Combinators
+ * @category combinators
  * @since 4.0.0
  */
 export const set: {
@@ -457,7 +457,7 @@ export const set: {
    * cache's TTL using a successful exit for the value, and may evict older
    * entries if the cache capacity is exceeded.
    *
-   * @category Combinators
+   * @category combinators
    * @since 4.0.0
    */
   <Key, A>(key: Key, value: A): <E, R>(self: ScopedCache<Key, A, E, R>) => Effect.Effect<void>
@@ -468,7 +468,7 @@ export const set: {
    * cache's TTL using a successful exit for the value, and may evict older
    * entries if the cache capacity is exceeded.
    *
-   * @category Combinators
+   * @category combinators
    * @since 4.0.0
    */
   <Key, A, E, R>(self: ScopedCache<Key, A, E, R>, key: Key, value: A): Effect.Effect<void>
@@ -490,7 +490,7 @@ export const set: {
          * cache's TTL using a successful exit for the value, and may evict older
          * entries if the cache capacity is exceeded.
          *
-         * @category Combinators
+         * @category combinators
          * @since 4.0.0
          */
         A, /**
@@ -500,7 +500,7 @@ export const set: {
          * cache's TTL using a successful exit for the value, and may evict older
          * entries if the cache capacity is exceeded.
          *
-         * @category Combinators
+         * @category combinators
          * @since 4.0.0
          */
         E>()
@@ -524,21 +524,21 @@ export const set: {
 /**
  * Checks if the cache contains an entry for the specified key.
  *
- * @category Combinators
+ * @category combinators
  * @since 4.0.0
  */
 export const has: {
   /**
    * Checks if the cache contains an entry for the specified key.
    *
-   * @category Combinators
+   * @category combinators
    * @since 4.0.0
    */
   <Key, A>(key: Key): <E, R>(self: ScopedCache<Key, A, E, R>) => Effect.Effect<boolean>
   /**
    * Checks if the cache contains an entry for the specified key.
    *
-   * @category Combinators
+   * @category combinators
    * @since 4.0.0
    */
   <Key, A, E, R>(self: ScopedCache<Key, A, E, R>, key: Key): Effect.Effect<boolean>
@@ -556,7 +556,7 @@ export const has: {
  * If the key is absent, this is a no-op. If the cache is closed, the effect is
  * interrupted.
  *
- * @category Combinators
+ * @category combinators
  * @since 4.0.0
  */
 export const invalidate: {
@@ -566,7 +566,7 @@ export const invalidate: {
    * If the key is absent, this is a no-op. If the cache is closed, the effect is
    * interrupted.
    *
-   * @category Combinators
+   * @category combinators
    * @since 4.0.0
    */
   <Key, A>(key: Key): <E, R>(self: ScopedCache<Key, A, E, R>) => Effect.Effect<void>
@@ -576,7 +576,7 @@ export const invalidate: {
    * If the key is absent, this is a no-op. If the cache is closed, the effect is
    * interrupted.
    *
-   * @category Combinators
+   * @category combinators
    * @since 4.0.0
    */
   <Key, A, E, R>(self: ScopedCache<Key, A, E, R>, key: Key): Effect.Effect<void>
@@ -599,7 +599,7 @@ export const invalidate: {
  * Conditionally invalidates the entry associated with the specified key in the cache
  * if the predicate returns true for the cached value.
  *
- * @category Combinators
+ * @category combinators
  * @since 4.0.0
  */
 export const invalidateWhen: {
@@ -607,7 +607,7 @@ export const invalidateWhen: {
    * Conditionally invalidates the entry associated with the specified key in the cache
    * if the predicate returns true for the cached value.
    *
-   * @category Combinators
+   * @category combinators
    * @since 4.0.0
    */
   <Key, A>(key: Key, f: Predicate.Predicate<A>): <E, R>(self: ScopedCache<Key, A, E, R>) => Effect.Effect<boolean>
@@ -615,7 +615,7 @@ export const invalidateWhen: {
    * Conditionally invalidates the entry associated with the specified key in the cache
    * if the predicate returns true for the cached value.
    *
-   * @category Combinators
+   * @category combinators
    * @since 4.0.0
    */
   <Key, A, E, R>(self: ScopedCache<Key, A, E, R>, key: Key, f: Predicate.Predicate<A>): Effect.Effect<boolean>
@@ -651,7 +651,7 @@ export const invalidateWhen: {
  * It will always invoke the lookup function to construct a new value,
  * overwriting any existing value for that key.
  *
- * @category Combinators
+ * @category combinators
  * @since 4.0.0
  */
 export const refresh: {
@@ -661,7 +661,7 @@ export const refresh: {
    * It will always invoke the lookup function to construct a new value,
    * overwriting any existing value for that key.
    *
-   * @category Combinators
+   * @category combinators
    * @since 4.0.0
    */
   <Key, A>(key: Key): <E, R>(self: ScopedCache<Key, A, E, R>) => Effect.Effect<A, E, R>
@@ -671,7 +671,7 @@ export const refresh: {
    * It will always invoke the lookup function to construct a new value,
    * overwriting any existing value for that key.
    *
-   * @category Combinators
+   * @category combinators
    * @since 4.0.0
    */
   <Key, A, E, R>(self: ScopedCache<Key, A, E, R>, key: Key): Effect.Effect<A, E, R>
@@ -688,7 +688,7 @@ export const refresh: {
        * It will always invoke the lookup function to construct a new value,
        * overwriting any existing value for that key.
        *
-       * @category Combinators
+       * @category combinators
        * @since 4.0.0
        */
       A, /**
@@ -697,7 +697,7 @@ export const refresh: {
        * It will always invoke the lookup function to construct a new value,
        * overwriting any existing value for that key.
        *
-       * @category Combinators
+       * @category combinators
        * @since 4.0.0
        */
       E>()
@@ -740,7 +740,7 @@ export const refresh: {
  *
  * If the cache is closed, the effect is interrupted.
  *
- * @category Combinators
+ * @category combinators
  * @since 4.0.0
  */
 export const invalidateAll = <Key, A, E, R>(self: ScopedCache<Key, A, E, R>): Effect.Effect<void> =>
@@ -770,7 +770,7 @@ const invalidateAllImpl = <Key, A, E>(
  * The size reflects the current number of entries stored, not the number
  * of valid entries.
  *
- * @category Combinators
+ * @category combinators
  * @since 4.0.0
  */
 export const size = <Key, A, E, R>(self: ScopedCache<Key, A, E, R>): Effect.Effect<number> =>
@@ -779,7 +779,7 @@ export const size = <Key, A, E, R>(self: ScopedCache<Key, A, E, R>): Effect.Effe
 /**
  * Retrieves all active keys from the cache, automatically filtering out expired entries.
  *
- * @category Combinators
+ * @category combinators
  * @since 4.0.0
  */
 export const keys = <Key, A, E, R>(self: ScopedCache<Key, A, E, R>): Effect.Effect<Array<Key>> =>
@@ -804,7 +804,7 @@ export const keys = <Key, A, E, R>(self: ScopedCache<Key, A, E, R>): Effect.Effe
  * Retrieves all successfully cached values from the cache, excluding failed
  * lookups and expired entries.
  *
- * @category Combinators
+ * @category combinators
  * @since 4.0.0
  */
 export const values = <Key, A, E, R>(self: ScopedCache<Key, A, E, R>): Effect.Effect<Array<A>> =>
@@ -815,7 +815,7 @@ export const values = <Key, A, E, R>(self: ScopedCache<Key, A, E, R>): Effect.Ef
  * 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: ScopedCache<Key, A, E, R>): Effect.Effect<Array<[Key, A]>> =>

package/src/Semaphore.ts

@@ -18,7 +18,7 @@
  *   the requested permits cannot be acquired immediately.
  * - Manual `take` / `release` usage must keep permit counts balanced.
  *
- * @since 2.0.0
+ * @since 4.0.0
  */
 import type * as Effect from "./Effect.ts"
 import type { Fiber } from "./Fiber.ts"
@@ -50,7 +50,7 @@ import type * as Option from "./Option.ts"
  * ```
  *
  * @category models
- * @since 2.0.0
+ * @since 4.0.0
  */
 export interface Semaphore {
   /**
@@ -126,12 +126,6 @@ export interface Semaphore {
  * Use this low-level constructor when an immediate semaphore value is required;
  * otherwise prefer the effectful `make` constructor.
  *
- * **Previously Known As**
- *
- * This API replaces the following from Effect 3.x:
- *
- * - `Effect.makeSemaphoreUnsafe`
- *
  * **Example** (Creating an unsafe semaphore)
  *
  * ```ts
@@ -159,7 +153,7 @@ export interface Semaphore {
  * ```
  *
  * @category constructors
- * @since 2.0.0
+ * @since 4.0.0
  */
 export const makeUnsafe = (permits: number): Semaphore => new SemaphoreImpl(permits)
 
@@ -273,12 +267,6 @@ class SemaphoreImpl implements Semaphore {
  * Use the returned semaphore to limit concurrency with `withPermit` or
  * `withPermits`, or to manually `take` and `release` permits.
  *
- * **Previously Known As**
- *
- * This API replaces the following from Effect 3.x:
- *
- * - `Effect.makeSemaphore`
- *
  * **Example** (Creating a semaphore)
  *
  * ```ts
@@ -302,7 +290,7 @@ class SemaphoreImpl implements Semaphore {
  * ```
  *
  * @category constructors
- * @since 2.0.0
+ * @since 4.0.0
  */
 export const make = (permits: number): Effect.Effect<Semaphore> => internal.sync(() => new SemaphoreImpl(permits))