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

package/src/Record.ts

@@ -56,7 +56,6 @@ export type ReadonlyRecord<in out K extends string | symbol, out A> = {
  * type CommonKeys = Record.ReadonlyRecord.IntersectKeys<"a" | "b", "b" | "c"> // "b"
  * ```
  *
- * @category models
  * @since 2.0.0
  */
 export declare namespace ReadonlyRecord {
@@ -357,7 +356,7 @@ export const fromEntries: <Entry extends readonly [string | symbol, any]>(
  * ], ["c", 3]])
  * ```
  *
- * @category conversions
+ * @category converting
  * @since 2.0.0
  */
 export const collect: {
@@ -377,7 +376,7 @@ export const collect: {
    * ], ["c", 3]])
    * ```
    *
-   * @category conversions
+   * @category converting
    * @since 2.0.0
    */
   <K extends string, A, B>(f: (key: K, a: A) => B): (self: ReadonlyRecord<K, A>) => Array<B>
@@ -397,7 +396,7 @@ export const collect: {
    * ], ["c", 3]])
    * ```
    *
-   * @category conversions
+   * @category converting
    * @since 2.0.0
    */
   <K extends string, A, B>(self: ReadonlyRecord<K, A>, f: (key: K, a: A) => B): Array<B>
@@ -425,7 +424,7 @@ export const collect: {
  * assert.deepStrictEqual(Record.toEntries(x), [["a", 1], ["b", 2], ["c", 3]])
  * ```
  *
- * @category conversions
+ * @category converting
  * @since 2.0.0
  */
 export const toEntries: <K extends string, A>(self: ReadonlyRecord<K, A>) => Array<[K, A]> = collect((
@@ -1294,7 +1293,7 @@ export const getSomes: <K extends string, A>(
  * ```
  *
  * @category filtering
- * @since 2.0.0
+ * @since 4.0.0
  */
 export const getFailures = <K extends string, A, E>(
   self: ReadonlyRecord<K, Result<A, E>>
@@ -1330,7 +1329,7 @@ export const getFailures = <K extends string, A, E>(
  * ```
  *
  * @category filtering
- * @since 2.0.0
+ * @since 4.0.0
  */
 export const getSuccesses = <K extends string, A, E>(
   self: ReadonlyRecord<K, Result<A, E>>
@@ -2198,7 +2197,7 @@ export const difference: {
  * ```
  *
  * @category instances
- * @since 2.0.0
+ * @since 4.0.0
  */
 export const makeEquivalence = <K extends string, A>(
   equivalence: Equivalence<A>
@@ -2231,6 +2230,7 @@ export const singleton = <K extends string | symbol, A>(key: K, value: A): Recor
  *
  * Values for keys that exist in both records are combined using the provided `Combiner`.
  *
+ * @category combining
  * @since 4.0.0
  */
 export function makeReducerUnion<K extends string, A>(combiner: Combiner.Combiner<A>): Reducer.Reducer<Record<K, A>> {
@@ -2248,6 +2248,7 @@ export function makeReducerUnion<K extends string, A>(combiner: Combiner.Combine
  * an empty record is empty, the default `combineAll` folds from `{}` and
  * therefore produces `{}` for ordinary non-empty inputs.
  *
+ * @category combining
  * @since 4.0.0
  */
 export function makeReducerIntersection<K extends string, A>(

package/src/Redactable.ts

@@ -100,7 +100,7 @@ import { hasProperty } from "./Predicate.ts"
  * - {@link isRedactable} - check whether a value has this symbol
  *
  * @category symbol
- * @since 4.0.0
+ * @since 3.10.0
  */
 export const symbolRedactable: unique symbol = Symbol.for("~effect/Redactable")
 
@@ -131,8 +131,8 @@ export const symbolRedactable: unique symbol = Symbol.for("~effect/Redactable")
  * - {@link redact} - apply redaction to any value
  * - {@link isRedactable} - type guard for this interface
  *
- * @category Model
- * @since 4.0.0
+ * @category models
+ * @since 3.10.0
  */
 export interface Redactable {
   readonly [symbolRedactable]: (context: Context.Context<never>) => unknown
@@ -147,7 +147,7 @@ export interface Redactable {
  * - {@link redact} - applies redaction if the value is redactable
  *
  * @category guards
- * @since 4.0.0
+ * @since 3.10.0
  */
 export const isRedactable = (u: unknown): u is Redactable => hasProperty(u, symbolRedactable)
 
@@ -167,7 +167,8 @@ export const isRedactable = (u: unknown): u is Redactable => hasProperty(u, symb
  * - {@link isRedactable} - check before redacting
  * - {@link getRedacted} - lower-level variant for known redactables
  *
- * @since 4.0.0
+ * @category destructors
+ * @since 3.10.0
  */
 export function redact(u: unknown): unknown {
   if (isRedactable(u)) return getRedacted(u)
@@ -189,6 +190,7 @@ export function redact(u: unknown): unknown {
  * - {@link redact} - higher-level variant that handles non-redactable values
  * - {@link isRedactable} - type guard to verify before calling this
  *
+ * @category destructors
  * @since 4.0.0
  */
 export function getRedacted(redactable: Redactable): unknown {

package/src/Redacted.ts

@@ -60,7 +60,6 @@ export interface Redacted<out A = string> extends Redacted.Variance<A>, Equal.Eq
  * const isRedacted = Redacted.isRedacted(secret) // true
  * ```
  *
- * @category namespace
  * @since 3.3.0
  */
 export declare namespace Redacted {
@@ -228,7 +227,7 @@ export const value: <T>(self: Redacted<T>) => T = redacted.value
  * ```
  *
  * @category unsafe
- * @since 3.3.0
+ * @since 4.0.0
  */
 export const wipeUnsafe = <T>(self: Redacted<T>): boolean => redacted.redactedRegistry.delete(self)
 
@@ -254,7 +253,7 @@ export const wipeUnsafe = <T>(self: Redacted<T>): boolean => redacted.redactedRe
  * ```
  *
  * @category equivalence
- * @since 3.3.0
+ * @since 4.0.0
  */
 export const makeEquivalence = <A>(isEquivalent: Equivalence.Equivalence<A>): Equivalence.Equivalence<Redacted<A>> =>
   Equivalence.make((x, y) => isEquivalent(value(x), value(y)))

package/src/Reducer.ts

@@ -103,7 +103,7 @@ import type * as Combiner from "./Combiner.ts"
  * @see {@link make} – create a `Reducer` from a function and initial value
  * @see {@link Combiner.Combiner} – parent interface without `initialValue`
  *
- * @category model
+ * @category models
  * @since 4.0.0
  */
 export interface Reducer<A> extends Combiner.Combiner<A> {
@@ -156,6 +156,7 @@ export interface Reducer<A> extends Combiner.Combiner<A> {
  * @see {@link Reducer} – the interface this creates
  * @see {@link flip} – reverse the argument order
  *
+ * @category constructors
  * @since 4.0.0
  */
 export function make<A>(
@@ -210,6 +211,7 @@ export function make<A>(
  * @see {@link make}
  * @see {@link Combiner.flip} – the same operation on a plain `Combiner`
  *
+ * @category combinators
  * @since 4.0.0
  */
 export function flip<A>(reducer: Reducer<A>): Reducer<A> {

package/src/Ref.ts

@@ -78,7 +78,6 @@ export interface Ref<in out A> extends Ref.Variance<A>, Pipeable {
 /**
  * The Ref namespace containing type definitions and utilities.
  *
- * @category models
  * @since 2.0.0
  */
 export declare namespace Ref {
@@ -158,9 +157,6 @@ export const makeUnsafe = <A>(value: A): Ref<A> => {
 /**
  * Creates a new Ref with the specified initial value.
  *
- * @param value - The initial value for the Ref
- * @returns An Effect that creates a new Ref
- *
  * **Example** (Creating a ref)
  *
  * ```ts
@@ -464,8 +460,7 @@ export const getAndUpdate = dual<
  * **Example** (Conditionally updating and returning the previous value)
  *
  * ```ts
- * import { Effect, Ref } from "effect"
- * import * as Option from "effect/Option"
+ * import { Effect, Option, Ref } from "effect"
  *
  * const program = Effect.gen(function*() {
  *   const counter = yield* Ref.make(5)
@@ -506,8 +501,7 @@ export const getAndUpdateSome = dual<
    * **Example** (Conditionally updating and returning the previous value)
    *
    * ```ts
-   * import { Effect, Ref } from "effect"
-   * import * as Option from "effect/Option"
+   * import { Effect, Option, Ref } from "effect"
    *
    * const program = Effect.gen(function*() {
    *   const counter = yield* Ref.make(5)
@@ -548,8 +542,7 @@ export const getAndUpdateSome = dual<
    * **Example** (Conditionally updating and returning the previous value)
    *
    * ```ts
-   * import { Effect, Ref } from "effect"
-   * import * as Option from "effect/Option"
+   * import { Effect, Option, Ref } from "effect"
    *
    * const program = Effect.gen(function*() {
    *   const counter = yield* Ref.make(5)
@@ -846,8 +839,7 @@ export const modify = dual<
  * **Example** (Conditionally modifying a value)
  *
  * ```ts
- * import { Effect, Ref } from "effect"
- * import * as Option from "effect/Option"
+ * import { Effect, Option, Ref } from "effect"
  *
  * const program = Effect.gen(function*() {
  *   const counter = yield* Ref.make(5)
@@ -899,8 +891,7 @@ export const modifySome: {
    * **Example** (Conditionally modifying a value)
    *
    * ```ts
-   * import { Effect, Ref } from "effect"
-   * import * as Option from "effect/Option"
+   * import { Effect, Option, Ref } from "effect"
    *
    * const program = Effect.gen(function*() {
    *   const counter = yield* Ref.make(5)
@@ -952,8 +943,7 @@ export const modifySome: {
    * **Example** (Conditionally modifying a value)
    *
    * ```ts
-   * import { Effect, Ref } from "effect"
-   * import * as Option from "effect/Option"
+   * import { Effect, Option, Ref } from "effect"
    *
    * const program = Effect.gen(function*() {
    *   const counter = yield* Ref.make(5)
@@ -1006,8 +996,7 @@ export const modifySome: {
    * **Example** (Conditionally modifying a value)
    *
    * ```ts
-   * import { Effect, Ref } from "effect"
-   * import * as Option from "effect/Option"
+   * import { Effect, Option, Ref } from "effect"
    *
    * const program = Effect.gen(function*() {
    *   const counter = yield* Ref.make(5)
@@ -1059,8 +1048,7 @@ export const modifySome: {
    * **Example** (Conditionally modifying a value)
    *
    * ```ts
-   * import { Effect, Ref } from "effect"
-   * import * as Option from "effect/Option"
+   * import { Effect, Option, Ref } from "effect"
    *
    * const program = Effect.gen(function*() {
    *   const counter = yield* Ref.make(5)
@@ -1289,8 +1277,7 @@ export const updateAndGet = dual<
  * **Example** (Conditionally updating a value)
  *
  * ```ts
- * import { Effect, Ref } from "effect"
- * import * as Option from "effect/Option"
+ * import { Effect, Option, Ref } from "effect"
  *
  * const program = Effect.gen(function*() {
  *   const counter = yield* Ref.make(5)
@@ -1329,8 +1316,7 @@ export const updateSome = dual<
    * **Example** (Conditionally updating a value)
    *
    * ```ts
-   * import { Effect, Ref } from "effect"
-   * import * as Option from "effect/Option"
+   * import { Effect, Option, Ref } from "effect"
    *
    * const program = Effect.gen(function*() {
    *   const counter = yield* Ref.make(5)
@@ -1369,8 +1355,7 @@ export const updateSome = dual<
    * **Example** (Conditionally updating a value)
    *
    * ```ts
-   * import { Effect, Ref } from "effect"
-   * import * as Option from "effect/Option"
+   * import { Effect, Option, Ref } from "effect"
    *
    * const program = Effect.gen(function*() {
    *   const counter = yield* Ref.make(5)
@@ -1418,8 +1403,7 @@ export const updateSome = dual<
  * **Example** (Conditionally updating and returning the current value)
  *
  * ```ts
- * import { Effect, Ref } from "effect"
- * import * as Option from "effect/Option"
+ * import { Effect, Option, Ref } from "effect"
  *
  * const program = Effect.gen(function*() {
  *   const counter = yield* Ref.make(10)
@@ -1454,8 +1438,7 @@ export const updateSomeAndGet = dual<
    * **Example** (Conditionally updating and returning the current value)
    *
    * ```ts
-   * import { Effect, Ref } from "effect"
-   * import * as Option from "effect/Option"
+   * import { Effect, Option, Ref } from "effect"
    *
    * const program = Effect.gen(function*() {
    *   const counter = yield* Ref.make(10)
@@ -1490,8 +1473,7 @@ export const updateSomeAndGet = dual<
    * **Example** (Conditionally updating and returning the current value)
    *
    * ```ts
-   * import { Effect, Ref } from "effect"
-   * import * as Option from "effect/Option"
+   * import { Effect, Option, Ref } from "effect"
    *
    * const program = Effect.gen(function*() {
    *   const counter = yield* Ref.make(10)
@@ -1548,6 +1530,6 @@ export const updateSomeAndGet = dual<
  * ```
  *
  * @category getters
- * @since 2.0.0
+ * @since 4.0.0
  */
 export const getUnsafe = <A>(self: Ref<A>): A => self.ref.current

package/src/RegExp.ts

@@ -56,7 +56,7 @@ export const isRegExp: (input: unknown) => input is RegExp = predicate.isRegExp
  * assert.deepStrictEqual(RegExp.escape("a*b"), "a\\*b")
  * ```
  *
- * @category utilities
+ * @category utils
  * @since 2.0.0
  */
 export const escape = (string: string): string => string.replace(/[/\\^$*+?.()|[\]{}]/g, "\\$&")

package/src/Request.ts

@@ -57,7 +57,7 @@ export interface Request<out A, out E = never, out R = never> extends Variance<A
  * requirements.
  *
  * @category models
- * @since 2.0.0
+ * @since 4.0.0
  */
 export type Any = Request<any, any, any>
 
@@ -206,6 +206,7 @@ const requestVariance = Equal.byReferenceUnsafe({
  * `Request.TaggedClass`. Most users should use those constructors instead of
  * interacting with the prototype directly.
  *
+ * @category models
  * @since 4.0.0
  */
 export const RequestPrototype: Request<any, any, any> = {

package/src/RequestResolver.ts

@@ -88,8 +88,8 @@ const TypeId = "~effect/RequestResolver"
  * **Example** (Defining a request resolver)
  *
  * ```ts
- * import type { Request } from "effect"
  * import { Effect, Exit, RequestResolver } from "effect"
+ * import type { Request } from "effect"
  *
  * interface GetUserRequest extends Request.Request<string, Error> {
  *   readonly _tag: "GetUserRequest"
@@ -139,7 +139,6 @@ export interface RequestResolver<in A extends Request.Any> extends RequestResolv
 /**
  * Namespace containing type-level helpers associated with `RequestResolver`.
  *
- * @category models
  * @since 2.0.0
  */
 export declare namespace RequestResolver {
@@ -463,8 +462,8 @@ export const fromEffect = <A extends Request.Any>(
  * **Example** (Handling tagged request batches)
  *
  * ```ts
- * import type { Request } from "effect"
  * import { Effect, RequestResolver } from "effect"
+ * import type { Request } from "effect"
  *
  * interface GetUser extends Request.Request<string, Error> {
  *   readonly _tag: "GetUser"

package/src/Resource.ts

@@ -63,7 +63,7 @@ export interface Resource<in out A, in out E = never> extends Pipeable {
  * Returns `true` if the specified value is a `Resource`.
  *
  * @category guards
- * @since 2.0.0
+ * @since 4.0.0
  */
 export const isResource: (u: unknown) => u is Resource<unknown, unknown> = (
   u: unknown