effect 3.13.8 → 3.13.9

package/src/Redacted.ts

@@ -80,6 +80,7 @@ export const make: <A>(value: A) => Redacted<A> = redacted_.make
  *
  * @example
  * ```ts
+ * import * as assert from "node:assert"
  * import { Redacted } from "effect"
  *
  * const API_KEY = Redacted.make("1234567890")
@@ -99,6 +100,7 @@ export const value: <A>(self: Redacted<A>) => A = redacted_.value
  *
  * @example
  * ```ts
+ * import * as assert from "node:assert"
  * import { Redacted } from "effect"
  *
  * const API_KEY = Redacted.make("1234567890")
@@ -122,6 +124,7 @@ export const unsafeWipe: <A>(self: Redacted<A>) => boolean = redacted_.unsafeWip
  *
  * @example
  * ```ts
+ * import * as assert from "node:assert"
  * import { Redacted, Equivalence } from "effect"
  *
  * const API_KEY1 = Redacted.make("1234567890")

package/src/RegExp.ts

@@ -8,10 +8,9 @@ import * as predicate from "./Predicate.js"
 /**
  * Tests if a value is a `RegExp`.
  *
- * @param input - The value to test.
- *
  * @example
  * ```ts
+ * import * as assert from "node:assert"
  * import { RegExp } from "effect"
  *
  * assert.deepStrictEqual(RegExp.isRegExp(/a/), true)
@@ -28,6 +27,7 @@ export const isRegExp: (input: unknown) => input is RegExp = predicate.isRegExp
  *
  * @example
  * ```ts
+ * import * as assert from "node:assert"
  * import { RegExp } from "effect"
  *
  * assert.deepStrictEqual(RegExp.escape("a*b"), "a\\*b")

package/src/STM.ts

@@ -1512,7 +1512,7 @@ export const isSuccess: <A, E, R>(self: STM<A, E, R>) => STM<boolean, never, R>
  * Iterates with the specified transactional function. The moral equivalent
  * of:
  *
- * ```ts
+ * ```ts skip-type-checking
  * const s = initial
  *
  * while (cont(s)) {
@@ -1537,7 +1537,7 @@ export const iterate: <Z, E, R>(
  * Loops with the specified transactional function, collecting the results
  * into a list. The moral equivalent of:
  *
- * ```ts
+ * ```ts skip-type-checking
  * const as = []
  * let s  = initial
  *
@@ -1557,7 +1557,7 @@ export const loop: {
    * Loops with the specified transactional function, collecting the results
    * into a list. The moral equivalent of:
    *
-   * ```ts
+   * ```ts skip-type-checking
    * const as = []
    * let s  = initial
    *
@@ -1585,7 +1585,7 @@ export const loop: {
    * Loops with the specified transactional function, collecting the results
    * into a list. The moral equivalent of:
    *
-   * ```ts
+   * ```ts skip-type-checking
    * const as = []
    * let s  = initial
    *
@@ -3006,9 +3006,7 @@ export const zipWith: {
  * iterable will be executed in sequence, and the first one that succeeds
  * will determine the outcome of the resulting `STM` value.
  *
- * @param effects - The iterable of `STM` values to evaluate.
- *
- * @returns A new `STM` value that represents the first successful
+ * Returns a new `STM` value that represents the first successful
  * `STM` value in the iterable, or a failed `STM` value if all of the
  * `STM` values in the iterable fail.
  *

package/src/Schedule.ts

@@ -48,11 +48,11 @@ export type ScheduleDriverTypeId = typeof ScheduleDriverTypeId
  *
  * The `Schedule` type is structured as follows:
  *
- * ```text
- *           ┌─── The type of output produced by the schedule
- *           │   ┌─── The type of input consumed by the schedule
- *           │   │     ┌─── Additional requirements for the schedule
- *           ▼   ▼     ▼
+ * ```ts skip-type-checking
+ * //        ┌─── The type of output produced by the schedule
+ * //        │   ┌─── The type of input consumed by the schedule
+ * //        │   │     ┌─── Additional requirements for the schedule
+ * //        ▼   ▼     ▼
  * Schedule<Out, In, Requirements>
  * ```
  *
@@ -1641,7 +1641,7 @@ export const fibonacci: (one: Duration.DurationInput) => Schedule<Duration.Durat
  * "pile-ups," ensuring that the schedule remains consistent without overlapping
  * executions.
  *
- * ```
+ * ```text
  * |-----interval-----|-----interval-----|-----interval-----|
  * |---------action--------||action|-----|action|-----------|
  * ```
@@ -3622,7 +3622,7 @@ export const whileOutputEffect: {
  * For example, `windowed(Duration.seconds(10))` would produce a schedule as
  * follows:
  *
- * ```
+ * ```text
  *      10s        10s        10s       10s
  * |----------|----------|----------|----------|
  * |action------|sleep---|act|-sleep|action----|

package/src/Schema.ts

@@ -716,8 +716,8 @@ export function Literal<Literals extends ReadonlyArray<AST.LiteralValue>>(
  *
  * @example
  * ```ts
- * import * as Schema from "effect/Schema"
- * import { Either } from "effect"
+ * import * as assert from "node:assert"
+ * import { Either, Schema } from "effect"
  *
  * const schema = Schema.Literal("a", "b", "c").pipe(Schema.pickLiteral("a", "b"))
  *
@@ -2995,6 +2995,7 @@ export interface tag<Tag extends AST.LiteralValue> extends PropertySignature<":"
  *
  * @example
  * ```ts
+ * import * as assert from "node:assert"
  * import { Schema } from "effect"
  *
  * const User = Schema.Struct({
@@ -3026,6 +3027,7 @@ export type TaggedStruct<Tag extends AST.LiteralValue, Fields extends Struct.Fie
  *
  * @example
  * ```ts
+ * import * as assert from "node:assert"
  * import { Schema } from "effect"
  *
  * const User = Schema.TaggedStruct("User", {
@@ -3347,9 +3349,6 @@ function makeBrandClass<S extends Schema.Any, B extends string | symbol>(
  * Schema<A> + B -> Schema<A & Brand<B>>
  * ```
  *
- * @param self - The input schema to be combined with the brand.
- * @param brand - The brand to apply.
- *
  * @example
  * ```ts
  * import * as Schema from "effect/Schema"
@@ -3435,8 +3434,6 @@ export interface mutable<S extends Schema.Any> extends
 /**
  * Creates a new schema with shallow mutability applied to its properties.
  *
- * @param schema - The original schema to make properties mutable (shallowly).
- *
  * @category combinators
  * @since 3.10.0
  */
@@ -3633,17 +3630,21 @@ export interface extend<Self extends Schema.Any, That extends Schema.Any> extend
 /**
  * Extends a schema with another schema.
  *
- * Not all extensions are supported, and their support depends on the nature of the involved schemas.
+ * Not all extensions are supported, and their support depends on the nature of
+ * the involved schemas.
  *
  * Possible extensions include:
  * - `Schema.String` with another `Schema.String` refinement or a string literal
  * - `Schema.Number` with another `Schema.Number` refinement or a number literal
- * - `Schema.Boolean` with another `Schema.Boolean` refinement or a boolean literal
+ * - `Schema.Boolean` with another `Schema.Boolean` refinement or a boolean
+ *   literal
  * - A struct with another struct where overlapping fields support extension
  * - A struct with in index signature
  * - A struct with a union of supported schemas
  * - A refinement of a struct with a supported schema
  * - A suspend of a struct with a supported schema
+ * - A transformation between structs where the “from” and “to” sides have no
+ *   overlapping fields with the target struct
  *
  * @example
  * ```ts
@@ -3677,17 +3678,21 @@ export const extend: {
   /**
    * Extends a schema with another schema.
    *
-   * Not all extensions are supported, and their support depends on the nature of the involved schemas.
+   * Not all extensions are supported, and their support depends on the nature of
+   * the involved schemas.
    *
    * Possible extensions include:
    * - `Schema.String` with another `Schema.String` refinement or a string literal
    * - `Schema.Number` with another `Schema.Number` refinement or a number literal
-   * - `Schema.Boolean` with another `Schema.Boolean` refinement or a boolean literal
+   * - `Schema.Boolean` with another `Schema.Boolean` refinement or a boolean
+   *   literal
    * - A struct with another struct where overlapping fields support extension
    * - A struct with in index signature
    * - A struct with a union of supported schemas
    * - A refinement of a struct with a supported schema
    * - A suspend of a struct with a supported schema
+   * - A transformation between structs where the “from” and “to” sides have no
+   *   overlapping fields with the target struct
    *
    * @example
    * ```ts
@@ -3721,17 +3726,21 @@ export const extend: {
   /**
    * Extends a schema with another schema.
    *
-   * Not all extensions are supported, and their support depends on the nature of the involved schemas.
+   * Not all extensions are supported, and their support depends on the nature of
+   * the involved schemas.
    *
    * Possible extensions include:
    * - `Schema.String` with another `Schema.String` refinement or a string literal
    * - `Schema.Number` with another `Schema.Number` refinement or a number literal
-   * - `Schema.Boolean` with another `Schema.Boolean` refinement or a boolean literal
+   * - `Schema.Boolean` with another `Schema.Boolean` refinement or a boolean
+   *   literal
    * - A struct with another struct where overlapping fields support extension
    * - A struct with in index signature
    * - A struct with a union of supported schemas
    * - A refinement of a struct with a supported schema
    * - A suspend of a struct with a supported schema
+   * - A transformation between structs where the “from” and “to” sides have no
+   *   overlapping fields with the target struct
    *
    * @example
    * ```ts
@@ -4303,6 +4312,7 @@ export interface transformLiteral<Type extends AST.LiteralValue, Encoded extends
  *
  * @example
  * ```ts
+ * import * as assert from "node:assert"
  * import * as S from "effect/Schema"
  *
  * const schema = S.transformLiteral(0, "a")
@@ -4329,6 +4339,7 @@ export function transformLiteral<Encoded extends AST.LiteralValue, Type extends
  *
  * @example
  * ```ts
+ * import * as assert from "node:assert"
  * import * as S from "effect/Schema"
  *
  * const Animal = S.transformLiterals(
@@ -4363,12 +4374,9 @@ export function transformLiterals<
  * This API is useful when you want to add a property to your schema which doesn't describe the shape of the input,
  * but rather maps to another schema, for example when you want to add a discriminant to a simple union.
  *
- * @param self - The input schema.
- * @param key - The name of the property to add to the schema.
- * @param value - The value of the property to add to the schema.
- *
  * @example
  * ```ts
+ * import * as assert from "node:assert"
  * import * as S from "effect/Schema"
  * import { pipe } from "effect/Function"
  *
@@ -4394,12 +4402,9 @@ export const attachPropertySignature: {
    * This API is useful when you want to add a property to your schema which doesn't describe the shape of the input,
    * but rather maps to another schema, for example when you want to add a discriminant to a simple union.
    *
-   * @param self - The input schema.
-   * @param key - The name of the property to add to the schema.
-   * @param value - The value of the property to add to the schema.
-   *
    * @example
    * ```ts
+   * import * as assert from "node:assert"
    * import * as S from "effect/Schema"
    * import { pipe } from "effect/Function"
    *
@@ -4431,12 +4436,9 @@ export const attachPropertySignature: {
    * This API is useful when you want to add a property to your schema which doesn't describe the shape of the input,
    * but rather maps to another schema, for example when you want to add a discriminant to a simple union.
    *
-   * @param self - The input schema.
-   * @param key - The name of the property to add to the schema.
-   * @param value - The value of the property to add to the schema.
-   *
    * @example
    * ```ts
+   * import * as assert from "node:assert"
    * import * as S from "effect/Schema"
    * import { pipe } from "effect/Function"
    *
@@ -5212,6 +5214,7 @@ const getParseJsonTransformation = (options?: ParseJsonOptions): SchemaClass<unk
  *
  * @example
  * ```ts
+ * import * as assert from "node:assert"
  * import * as Schema from "effect/Schema"
  *
  * assert.deepStrictEqual(Schema.decodeUnknownSync(Schema.parseJson())(`{"a":"1"}`), { a: "1" })
@@ -5232,6 +5235,7 @@ export const parseJson: {
    *
    * @example
    * ```ts
+   * import * as assert from "node:assert"
    * import * as Schema from "effect/Schema"
    *
    * assert.deepStrictEqual(Schema.decodeUnknownSync(Schema.parseJson())(`{"a":"1"}`), { a: "1" })
@@ -5252,6 +5256,7 @@ export const parseJson: {
    *
    * @example
    * ```ts
+   * import * as assert from "node:assert"
    * import * as Schema from "effect/Schema"
    *
    * assert.deepStrictEqual(Schema.decodeUnknownSync(Schema.parseJson())(`{"a":"1"}`), { a: "1" })
@@ -5828,6 +5833,7 @@ export type JsonNumberSchemaId = typeof JsonNumberSchemaId
  *
  * @example
  * ```ts
+ * import * as assert from "node:assert"
  * import * as Schema from "effect/Schema"
  *
  * const is = Schema.is(S.JsonNumber)

package/src/SchemaAST.ts

@@ -2521,8 +2521,6 @@ export const required = (ast: AST): AST => {
 /**
  * Creates a new AST with shallow mutability applied to its properties.
  *
- * @param ast - The original AST to make properties mutable (shallowly).
- *
  * @since 3.10.0
  */
 export const mutable = (ast: AST): AST => {

package/src/Sink.ts

@@ -988,14 +988,14 @@ export const foldUntilEffect: <S, In, E, R>(
 ) => Sink<S, In, In, E, R> = internal.foldUntilEffect
 
 /**
- * Creates a sink that folds elements of type `In` into a structure of type
- * `S`, until `max` worth of elements (determined by the `costFn`) have been
- * folded.
+ * Creates a sink that folds elements of type `In` into a structure of type `S`,
+ * until `max` worth of elements (determined by the `costFn`) have been folded.
  *
- * @note
- *   Elements that have an individual cost larger than `max` will force the
- *   sink to cross the `max` cost. See `Sink.foldWeightedDecompose` for a
- *   variant that can handle these cases.
+ * **Note**
+ *
+ * Elements that have an individual cost larger than `max` will force the sink
+ * to cross the `max` cost. See `Sink.foldWeightedDecompose` for a variant
+ * that can handle these cases.
  *
  * @since 2.0.0
  * @category constructors
@@ -1017,7 +1017,7 @@ export const foldWeighted: <S, In>(
  * The `decompose` function will be used for decomposing elements that cause
  * an `S` aggregate to cross `max` into smaller elements. For example:
  *
- * ```ts
+ * ```ts skip-type-checking
  * pipe(
  *   Stream.make(1, 5, 1),
  *   Stream.transduce(
@@ -1214,7 +1214,9 @@ export const fromEffect: <A, E, R>(effect: Effect.Effect<A, E, R>) => Sink<A, un
 /**
  * Create a sink which publishes each element to the specified `PubSub`.
  *
- * @param shutdown If `true`, the `PubSub` will be shutdown after the sink is evaluated (defaults to `false`)
+ * If the `shutdown` parameter is `true`, the `PubSub` will be shutdown after
+ * the sink is evaluated (defaults to `false`).
+ *
  * @since 2.0.0
  * @category constructors
  */
@@ -1242,7 +1244,9 @@ export const fromPush: <In, L0, R0, L, R>(
 /**
  * Create a sink which enqueues each element into the specified queue.
  *
- * @param shutdown If `true`, the queue will be shutdown after the sink is evaluated (defaults to `false`)
+ * If the `shutdown` parameter is `true`, the queue will be shutdown after the
+ * sink is evaluated (defaults to `false`).
+ *
  * @since 2.0.0
  * @category constructors
  */