effect 3.10.18 → 3.11.0

package/dist/dts/Schema.d.ts

@@ -370,6 +370,7 @@ export declare function Literal<Literals extends ReadonlyArray<AST.LiteralValue>
  * Creates a new `Schema` from a literal schema.
  *
  * @example
+ * ```ts
  * import * as Schema from "effect/Schema"
  * import { Either } from "effect"
  *
@@ -378,6 +379,7 @@ export declare function Literal<Literals extends ReadonlyArray<AST.LiteralValue>
  * assert.deepStrictEqual(Schema.decodeSync(schema)("a"), "a")
  * assert.deepStrictEqual(Schema.decodeSync(schema)("b"), "b")
  * assert.strictEqual(Either.isLeft(Schema.decodeUnknownEither(schema)("c")), true)
+ * ```
  *
  * @category constructors
  * @since 3.10.0
@@ -1297,6 +1299,7 @@ export interface tag<Tag extends AST.LiteralValue> extends PropertySignature<":"
  * @see {@link TaggedStruct}
  *
  * @example
+ * ```ts
  * import { Schema } from "effect"
  *
  * const User = Schema.Struct({
@@ -1306,6 +1309,7 @@ export interface tag<Tag extends AST.LiteralValue> extends PropertySignature<":"
  * })
  *
  * assert.deepStrictEqual(User.make({ name: "John", age: 44 }), { _tag: "User", name: "John", age: 44 })
+ * ```
  *
  * @since 3.10.0
  */
@@ -1323,6 +1327,7 @@ export type TaggedStruct<Tag extends AST.LiteralValue, Fields extends Struct.Fie
  * The tag is optional when using the `make` method.
  *
  * @example
+ * ```ts
  * import { Schema } from "effect"
  *
  * const User = Schema.TaggedStruct("User", {
@@ -1331,6 +1336,7 @@ export type TaggedStruct<Tag extends AST.LiteralValue, Fields extends Struct.Fie
  * })
  *
  * assert.deepStrictEqual(User.make({ name: "John", age: 44 }), { _tag: "User", name: "John", age: 44 })
+ * ```
  *
  * @category constructors
  * @since 3.10.0
@@ -1374,6 +1380,7 @@ export declare const omit: <A, I, Keys extends ReadonlyArray<keyof A & keyof I>>
  * producing a new schema that represents a transformation from the `{ readonly [key]: I[K] }` type to `A[K]`.
  *
  * @example
+ * ```ts
  * import * as Schema from "effect/Schema"
  *
  * // ---------------------------------------------
@@ -1393,6 +1400,7 @@ export declare const omit: <A, I, Keys extends ReadonlyArray<keyof A & keyof I>>
  *
  * console.log(Schema.decodeUnknownEither(Schema.Array(pullOutColumn))([{ column1: "1", column2: 100 }, { column1: "2", column2: 300 }]))
  * // Output: { _id: 'Either', _tag: 'Right', right: [ 1, 2 ] }
+ * ```
  *
  * @category struct transformations
  * @since 3.10.0
@@ -1403,6 +1411,7 @@ export declare const pluck: {
      * producing a new schema that represents a transformation from the `{ readonly [key]: I[K] }` type to `A[K]`.
      *
      * @example
+     * ```ts
      * import * as Schema from "effect/Schema"
      *
      * // ---------------------------------------------
@@ -1422,6 +1431,7 @@ export declare const pluck: {
      *
      * console.log(Schema.decodeUnknownEither(Schema.Array(pullOutColumn))([{ column1: "1", column2: 100 }, { column1: "2", column2: 300 }]))
      * // Output: { _id: 'Either', _tag: 'Right', right: [ 1, 2 ] }
+     * ```
      *
      * @category struct transformations
      * @since 3.10.0
@@ -1434,6 +1444,7 @@ export declare const pluck: {
      * producing a new schema that represents a transformation from the `{ readonly [key]: I[K] }` type to `A[K]`.
      *
      * @example
+     * ```ts
      * import * as Schema from "effect/Schema"
      *
      * // ---------------------------------------------
@@ -1453,6 +1464,7 @@ export declare const pluck: {
      *
      * console.log(Schema.decodeUnknownEither(Schema.Array(pullOutColumn))([{ column1: "1", column2: 100 }, { column1: "2", column2: 300 }]))
      * // Output: { _id: 'Either', _tag: 'Right', right: [ 1, 2 ] }
+     * ```
      *
      * @category struct transformations
      * @since 3.10.0
@@ -1486,10 +1498,12 @@ export interface brand<S extends Schema.Any, B extends string | symbol> extends
  * @param brand - The brand to apply.
  *
  * @example
+ * ```ts
  * import * as Schema from "effect/Schema"
  *
  * const Int = Schema.Number.pipe(Schema.int(), Schema.brand("Int"))
  * type Int = Schema.Schema.Type<typeof Int> // number & Brand<"Int">
+ * ```
  *
  * @category branding
  * @since 3.10.0
@@ -1570,6 +1584,7 @@ export interface extend<Self extends Schema.Any, That extends Schema.Any> extend
  * - A suspend of a struct with a supported schema
  *
  * @example
+ * ```ts
  * import * as Schema from "effect/Schema"
  *
  * const schema = Schema.Struct({
@@ -1591,6 +1606,7 @@ export interface extend<Self extends Schema.Any, That extends Schema.Any> extend
  *   Schema.extend(Schema.Struct({ c: Schema.String })), // <= you can add more fields
  *   Schema.extend(Schema.Record({ key: Schema.String, value: Schema.String })) // <= you can add index signatures
  * ))
+ * ```
  *
  * @category combinators
  * @since 3.10.0
@@ -1612,6 +1628,7 @@ export declare const extend: {
      * - A suspend of a struct with a supported schema
      *
      * @example
+     * ```ts
      * import * as Schema from "effect/Schema"
      *
      * const schema = Schema.Struct({
@@ -1633,6 +1650,7 @@ export declare const extend: {
      *   Schema.extend(Schema.Struct({ c: Schema.String })), // <= you can add more fields
      *   Schema.extend(Schema.Record({ key: Schema.String, value: Schema.String })) // <= you can add index signatures
      * ))
+     * ```
      *
      * @category combinators
      * @since 3.10.0
@@ -1654,6 +1672,7 @@ export declare const extend: {
      * - A suspend of a struct with a supported schema
      *
      * @example
+     * ```ts
      * import * as Schema from "effect/Schema"
      *
      * const schema = Schema.Struct({
@@ -1675,6 +1694,7 @@ export declare const extend: {
      *   Schema.extend(Schema.Struct({ c: Schema.String })), // <= you can add more fields
      *   Schema.extend(Schema.Record({ key: Schema.String, value: Schema.String })) // <= you can add index signatures
      * ))
+     * ```
      *
      * @category combinators
      * @since 3.10.0
@@ -1922,11 +1942,13 @@ export interface transformLiteral<Type, Encoded> extends Annotable<transformLite
  * Creates a new `Schema` which transforms literal values.
  *
  * @example
+ * ```ts
  * import * as S from "effect/Schema"
  *
  * const schema = S.transformLiteral(0, "a")
  *
  * assert.deepStrictEqual(S.decodeSync(schema)(0), "a")
+ * ```
  *
  * @category constructors
  * @since 3.10.0
@@ -1936,6 +1958,7 @@ export declare const transformLiteral: <Encoded extends AST.LiteralValue, Type e
  * Creates a new `Schema` which maps between corresponding literal values.
  *
  * @example
+ * ```ts
  * import * as S from "effect/Schema"
  *
  * const Animal = S.transformLiterals(
@@ -1945,6 +1968,7 @@ export declare const transformLiteral: <Encoded extends AST.LiteralValue, Type e
  * )
  *
  * assert.deepStrictEqual(S.decodeSync(Animal)(1), "dog")
+ * ```
  *
  * @category constructors
  * @since 3.10.0
@@ -1964,6 +1988,7 @@ export declare function transformLiterals<const A extends ReadonlyArray<readonly
  * @param value - The value of the property to add to the schema.
  *
  * @example
+ * ```ts
  * import * as S from "effect/Schema"
  * import { pipe } from "effect/Function"
  *
@@ -1978,6 +2003,7 @@ export declare function transformLiterals<const A extends ReadonlyArray<readonly
  *   kind: "circle",
  *   radius: 10
  * })
+ * ```
  *
  * @category combinators
  * @since 3.10.0
@@ -1993,6 +2019,7 @@ export declare const attachPropertySignature: {
      * @param value - The value of the property to add to the schema.
      *
      * @example
+     * ```ts
      * import * as S from "effect/Schema"
      * import { pipe } from "effect/Function"
      *
@@ -2007,6 +2034,7 @@ export declare const attachPropertySignature: {
      *   kind: "circle",
      *   radius: 10
      * })
+     * ```
      *
      * @category combinators
      * @since 3.10.0
@@ -2026,6 +2054,7 @@ export declare const attachPropertySignature: {
      * @param value - The value of the property to add to the schema.
      *
      * @example
+     * ```ts
      * import * as S from "effect/Schema"
      * import { pipe } from "effect/Function"
      *
@@ -2040,6 +2069,7 @@ export declare const attachPropertySignature: {
      *   kind: "circle",
      *   radius: 10
      * })
+     * ```
      *
      * @category combinators
      * @since 3.10.0
@@ -2383,11 +2413,13 @@ declare const NonEmptyTrimmedString_base: filter<Schema<string, string, never>>;
  * leading or trailing whitespace.
  *
  * @example
+ * ```ts
  * import { Schema } from "effect"
  *
  * console.log(Schema.decodeOption(Schema.NonEmptyTrimmedString)("")) // Option.none()
  * console.log(Schema.decodeOption(Schema.NonEmptyTrimmedString)(" a ")) // Option.none()
  * console.log(Schema.decodeOption(Schema.NonEmptyTrimmedString)("a")) // Option.some("a")
+ * ```
  *
  * @category string constructors
  * @since 3.10.0
@@ -2427,10 +2459,12 @@ export type ParseJsonOptions = {
  * Optionally, you can pass a schema `Schema<A, I, R>` to obtain an `A` type instead of `unknown`.
  *
  * @example
+ * ```ts
  * import * as Schema from "effect/Schema"
  *
  * assert.deepStrictEqual(Schema.decodeUnknownSync(Schema.parseJson())(`{"a":"1"}`), { a: "1" })
  * assert.deepStrictEqual(Schema.decodeUnknownSync(Schema.parseJson(Schema.Struct({ a: Schema.NumberFromString })))(`{"a":"1"}`), { a: 1 })
+ * ```
  *
  * @category string transformations
  * @since 3.10.0
@@ -2445,10 +2479,12 @@ export declare const parseJson: {
      * Optionally, you can pass a schema `Schema<A, I, R>` to obtain an `A` type instead of `unknown`.
      *
      * @example
+     * ```ts
      * import * as Schema from "effect/Schema"
      *
      * assert.deepStrictEqual(Schema.decodeUnknownSync(Schema.parseJson())(`{"a":"1"}`), { a: "1" })
      * assert.deepStrictEqual(Schema.decodeUnknownSync(Schema.parseJson(Schema.Struct({ a: Schema.NumberFromString })))(`{"a":"1"}`), { a: 1 })
+     * ```
      *
      * @category string transformations
      * @since 3.10.0
@@ -2463,10 +2499,12 @@ export declare const parseJson: {
      * Optionally, you can pass a schema `Schema<A, I, R>` to obtain an `A` type instead of `unknown`.
      *
      * @example
+     * ```ts
      * import * as Schema from "effect/Schema"
      *
      * assert.deepStrictEqual(Schema.decodeUnknownSync(Schema.parseJson())(`{"a":"1"}`), { a: "1" })
      * assert.deepStrictEqual(Schema.decodeUnknownSync(Schema.parseJson(Schema.Struct({ a: Schema.NumberFromString })))(`{"a":"1"}`), { a: 1 })
+     * ```
      *
      * @category string transformations
      * @since 3.10.0
@@ -2513,6 +2551,28 @@ declare const ULID_base: filter<Schema<string, string, never>>;
  */
 export declare class ULID extends ULID_base {
 }
+declare const URLFromSelf_base: instanceOf<URL>;
+/**
+ * Defines a schema that represents a `URL` object.
+ *
+ * @category URL constructors
+ * @since 3.11.0
+ */
+export declare class URLFromSelf extends URLFromSelf_base {
+}
+declare const URL$_base: transformOrFail<SchemaClass<string, string, never>, typeof URLFromSelf, never>;
+/** @ignore */
+declare class URL$ extends URL$_base {
+}
+export { 
+/**
+ * Defines a schema that attempts to convert a `string` to a `URL` object using
+ * the `new URL` constructor.
+ *
+ * @category URL transformations
+ * @since 3.11.0
+ */
+URL$ as URL };
 /**
  * @category schema id
  * @since 3.10.0
@@ -2759,6 +2819,7 @@ declare const JsonNumber_base: filter<typeof Number$>;
  * format.
  *
  * @example
+ * ```ts
  * import * as Schema from "effect/Schema"
  *
  * const is = Schema.is(S.JsonNumber)
@@ -2767,6 +2828,7 @@ declare const JsonNumber_base: filter<typeof Number$>;
  * assert.deepStrictEqual(is(Number.NaN), false)
  * assert.deepStrictEqual(is(Number.POSITIVE_INFINITY), false)
  * assert.deepStrictEqual(is(Number.NEGATIVE_INFINITY), false)
+ * ```
  *
  * @category number constructors
  * @since 3.10.0
@@ -3518,11 +3580,13 @@ export declare const OptionFromUndefinedOr: <Value extends Schema.Any>(value: Va
  * `none` for invalid inputs and `some` for valid non-empty strings.
  *
  * @example
+ * ```ts
  * import { Schema } from "effect"
  *
  * console.log(Schema.decodeSync(Schema.OptionFromNonEmptyTrimmedString)("")) // Option.none()
  * console.log(Schema.decodeSync(Schema.OptionFromNonEmptyTrimmedString)(" a ")) // Option.some("a")
  * console.log(Schema.decodeSync(Schema.OptionFromNonEmptyTrimmedString)("a")) // Option.some("a")
+ * ```
  *
  * @category Option transformations
  * @since 3.10.0
@@ -3585,10 +3649,12 @@ export interface EitherFromUnion<R extends Schema.All, L extends Schema.All> ext
 }
 /**
  * @example
+ * ```ts
  * import * as Schema from "effect/Schema"
  *
  * // Schema<string | number, Either<string, number>>
  * Schema.EitherFromUnion({ left: Schema.String, right: Schema.Number })
+ * ```
  *
  * @category Either transformations
  * @since 3.10.0
@@ -3938,6 +4004,7 @@ export interface Class<Self, Fields extends Struct.Fields, I, R, C, Inherited, P
     readonly identifier: string;
     /**
      * @example
+     * ```ts
      * import { Schema } from "effect"
      *
      * class MyClass extends Schema.Class<MyClass>("MyClass")({
@@ -3955,10 +4022,12 @@ export interface Class<Self, Fields extends Struct.Fields, I, R, C, Inherited, P
      *    return this.myMethod() + this.myField + this.nextField
      *  }
      * }
+     * ```
      */
     extend<Extended = never>(identifier: string): <newFields extends Struct.Fields>(fields: newFields | HasFields<newFields>, annotations?: Annotations.Schema<Extended>) => [Extended] extends [never] ? MissingSelfGeneric<"Base.extend"> : Class<Extended, Fields & newFields, I & Struct.Encoded<newFields>, R | Struct.Context<newFields>, C & Struct.Constructor<newFields>, Self, Proto>;
     /**
      * @example
+     * ```ts
      * import { Effect, Schema } from "effect"
      *
      * class MyClass extends Schema.Class<MyClass>("MyClass")({
@@ -3983,6 +4052,7 @@ export interface Class<Self, Fields extends Struct.Fields, I, R, C, Inherited, P
      *     return this.myMethod() + this.myField + this.nextField
      *   }
      * }
+     * ```
      */
     transformOrFail<Transformed = never>(identifier: string): <newFields extends Struct.Fields, R2, R3>(fields: newFields, options: {
         readonly decode: (input: Simplify<Struct.Type<Fields>>, options: ParseOptions, ast: AST.Transformation) => Effect.Effect<Simplify<Struct.Type<Fields & newFields>>, ParseResult.ParseIssue, R2>;
@@ -3990,6 +4060,7 @@ export interface Class<Self, Fields extends Struct.Fields, I, R, C, Inherited, P
     }, annotations?: Annotations.Schema<Transformed>) => [Transformed] extends [never] ? MissingSelfGeneric<"Base.transformOrFail"> : Class<Transformed, Fields & newFields, I, R | Struct.Context<newFields> | R2 | R3, C & Struct.Constructor<newFields>, Self, Proto>;
     /**
      * @example
+     * ```ts
      * import { Effect, Schema } from "effect"
      *
      * class MyClass extends Schema.Class<MyClass>("MyClass")({
@@ -4014,6 +4085,7 @@ export interface Class<Self, Fields extends Struct.Fields, I, R, C, Inherited, P
      *     return this.myMethod() + this.myField + this.nextField
      *   }
      * }
+     * ```
      */
     transformOrFailFrom<Transformed = never>(identifier: string): <newFields extends Struct.Fields, R2, R3>(fields: newFields, options: {
         readonly decode: (input: Simplify<I>, options: ParseOptions, ast: AST.Transformation) => Effect.Effect<Simplify<I & Struct.Encoded<newFields>>, ParseResult.ParseIssue, R2>;
@@ -4025,6 +4097,7 @@ type HasFields<Fields extends Struct.Fields> = Struct<Fields> | {
 };
 /**
  * @example
+ * ```ts
  * import { Schema } from "effect"
  *
  * class MyClass extends Schema.Class<MyClass>("MyClass")({
@@ -4034,6 +4107,7 @@ type HasFields<Fields extends Struct.Fields> = Struct<Fields> | {
  *    return this.someField + "bar"
  *  }
  * }
+ * ```
  *
  * @category classes
  * @since 3.10.0
@@ -4048,11 +4122,13 @@ export interface TaggedClass<Self, Tag extends string, Fields extends Struct.Fie
 }
 /**
  * @example
+ * ```ts
  * import { Schema } from "effect"
  *
  * class MyClass extends Schema.TaggedClass<MyClass>("MyClass")("MyClass", {
  *  a: Schema.String
  * }) {}
+ * ```
  *
  * @category classes
  * @since 3.10.0
@@ -4069,6 +4145,7 @@ export interface TaggedErrorClass<Self, Tag extends string, Fields extends Struc
 }
 /**
  * @example
+ * ```ts
  * import { Schema } from "effect"
  *
  * class MyError extends Schema.TaggedError<MyError>("MyError")(
@@ -4083,6 +4160,7 @@ export interface TaggedErrorClass<Self, Tag extends string, Fields extends Struc
  *     return `${this.module}.${this.method}: ${this.description}`
  *   }
  * }
+ * ```
  * @category classes
  * @since 3.10.0
  */
@@ -4339,6 +4417,16 @@ declare const BooleanFromUnknown_base: transform<typeof Unknown, typeof Boolean$
  */
 export declare class BooleanFromUnknown extends BooleanFromUnknown_base {
 }
+declare const BooleanFromString_base: transform<Literal<["true", "false"]>, typeof Boolean$>;
+/**
+ * Converts an `string` value into its corresponding `boolean`
+ * ("true" as `true` and "false" as `false`).
+ *
+ * @category boolean transformations
+ * @since 3.11.0
+ */
+export declare class BooleanFromString extends BooleanFromString_base {
+}
 /**
  * @category Config validations
  * @since 3.10.0
@@ -4650,6 +4738,7 @@ export interface TaggedRequestClass<Self, Tag extends string, Payload extends St
 }
 /**
  * @example
+ * ```ts
  * import { Schema } from "effect"
  *
  * class MyRequest extends Schema.TaggedRequest<MyRequest>("MyRequest")("MyRequest", {
@@ -4657,6 +4746,7 @@ export interface TaggedRequestClass<Self, Tag extends string, Payload extends St
  *  success: Schema.Number,
  *  payload: { id: Schema.String }
  * }) {}
+ * ```
  *
  * @category classes
  * @since 3.10.0