effect 3.13.8 → 3.13.9

package/dist/dts/Schema.d.ts

@@ -401,8 +401,8 @@ export declare 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"))
  *
@@ -1356,6 +1356,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({
@@ -1384,6 +1385,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", {
@@ -1547,9 +1549,6 @@ export interface brand<S extends Schema.Any, B extends string | symbol> extends
  * 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"
@@ -1609,8 +1608,6 @@ export interface mutable<S extends Schema.Any> extends AnnotableClass<mutable<S>
 /**
  * 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
  */
@@ -1624,17 +1621,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
@@ -1668,17 +1669,21 @@ export declare 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
@@ -1712,17 +1717,21 @@ export declare 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
@@ -1998,6 +2007,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")
@@ -2014,6 +2024,7 @@ export declare function transformLiteral<Encoded extends AST.LiteralValue, Type
  *
  * @example
  * ```ts
+ * import * as assert from "node:assert"
  * import * as S from "effect/Schema"
  *
  * const Animal = S.transformLiterals(
@@ -2038,12 +2049,9 @@ export declare function transformLiterals<const A extends ReadonlyArray<readonly
  * 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"
  *
@@ -2069,12 +2077,9 @@ export declare 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"
      *
@@ -2104,12 +2109,9 @@ export declare 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"
      *
@@ -2523,6 +2525,7 @@ export type ParseJsonOptions = {
  *
  * @example
  * ```ts
+ * import * as assert from "node:assert"
  * import * as Schema from "effect/Schema"
  *
  * assert.deepStrictEqual(Schema.decodeUnknownSync(Schema.parseJson())(`{"a":"1"}`), { a: "1" })
@@ -2543,6 +2546,7 @@ export declare 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" })
@@ -2563,6 +2567,7 @@ export declare 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" })
@@ -2901,6 +2906,7 @@ declare const JsonNumber_base: filter<typeof Number$>;
  *
  * @example
  * ```ts
+ * import * as assert from "node:assert"
  * import * as Schema from "effect/Schema"
  *
  * const is = Schema.is(S.JsonNumber)