effect 3.13.8 → 3.13.9

package/dist/esm/Schema.js

@@ -423,8 +423,8 @@ export function Literal(...literals) {
  *
  * @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"))
  *
@@ -1332,6 +1332,7 @@ export function Struct(fields, ...records) {
  *
  * @example
  * ```ts
+ * import * as assert from "node:assert"
  * import { Schema } from "effect"
  *
  * const User = Schema.Struct({
@@ -1353,6 +1354,7 @@ export const tag = tag => Literal(tag).pipe(propertySignature, withConstructorDe
  *
  * @example
  * ```ts
+ * import * as assert from "node:assert"
  * import { Schema } from "effect"
  *
  * const User = Schema.TaggedStruct("User", {
@@ -1455,9 +1457,6 @@ function makeBrandClass(from, ast) {
  * 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"
@@ -1498,8 +1497,6 @@ export const required = self => make(AST.required(self.ast));
 /**
  * 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
  */
@@ -1633,17 +1630,21 @@ const intersectUnionMembers = (xs, ys, path) => array_.flatMap(xs, x => array_.f
 /**
  * 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
@@ -1785,6 +1786,7 @@ export const transform = /*#__PURE__*/dual(args => isSchema(args[0]) && isSchema
  *
  * @example
  * ```ts
+ * import * as assert from "node:assert"
  * import * as S from "effect/Schema"
  *
  * const schema = S.transformLiteral(0, "a")
@@ -1810,12 +1812,9 @@ export function transformLiterals(...pairs) {
  * 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"
  *
@@ -2315,6 +2314,7 @@ const getParseJsonTransformation = options => transformOrFail(String$.annotation
  *
  * @example
  * ```ts
+ * import * as assert from "node:assert"
  * import * as Schema from "effect/Schema"
  *
  * assert.deepStrictEqual(Schema.decodeUnknownSync(Schema.parseJson())(`{"a":"1"}`), { a: "1" })
@@ -2732,6 +2732,7 @@ export const JsonNumberSchemaId = schemaId_.JsonNumberSchemaId;
  *
  * @example
  * ```ts
+ * import * as assert from "node:assert"
  * import * as Schema from "effect/Schema"
  *
  * const is = Schema.is(S.JsonNumber)