effect 3.10.7 → 3.10.8

package/dist/dts/Schema.d.ts

@@ -3936,11 +3936,85 @@ export interface Class<Self, Fields extends Struct.Fields, I, R, C, Inherited, P
         readonly [K in keyof Fields]: Fields[K];
     };
     readonly identifier: string;
+    /**
+     * @example
+     * import { Schema } from "effect"
+     *
+     * class MyClass extends Schema.Class<MyClass>("MyClass")({
+     *  myField: Schema.String
+     * }) {
+     *  myMethod() {
+     *    return this.myField + "my"
+     *  }
+     * }
+     *
+     * class NextClass extends MyClass.extend<NextClass>("NextClass")({
+     *  nextField: Schema.Number
+     * }) {
+     *  nextMethod() {
+     *    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
+     * import { Effect, Schema } from "effect"
+     *
+     * class MyClass extends Schema.Class<MyClass>("MyClass")({
+     *   myField: Schema.String
+     * }) {
+     *   myMethod() {
+     *     return this.myField + "my"
+     *   }
+     * }
+     *
+     * class NextClass extends MyClass.transformOrFail<NextClass>("NextClass")({
+     *   nextField: Schema.Number
+     * }, {
+     *   decode: (i) =>
+     *     Effect.succeed({
+     *       myField: i.myField,
+     *       nextField: i.myField.length
+     *     }),
+     *   encode: (a) => Effect.succeed({ myField: a.myField })
+     * }) {
+     *   nextMethod() {
+     *     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>;
         readonly encode: (input: Simplify<Struct.Type<Fields & newFields>>, options: ParseOptions, ast: AST.Transformation) => Effect.Effect<Struct.Type<Fields>, ParseResult.ParseIssue, R3>;
     }, 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
+     * import { Effect, Schema } from "effect"
+     *
+     * class MyClass extends Schema.Class<MyClass>("MyClass")({
+     *   myField: Schema.String
+     * }) {
+     *   myMethod() {
+     *     return this.myField + "my"
+     *   }
+     * }
+     *
+     * class NextClass extends MyClass.transformOrFailFrom<NextClass>("NextClass")({
+     *   nextField: Schema.Number
+     * }, {
+     *   decode: (i) =>
+     *     Effect.succeed({
+     *       myField: i.myField,
+     *       nextField: i.myField.length
+     *     }),
+     *   encode: (a) => Effect.succeed({ myField: a.myField })
+     * }) {
+     *   nextMethod() {
+     *     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>;
         readonly encode: (input: Simplify<I & Struct.Encoded<newFields>>, options: ParseOptions, ast: AST.Transformation) => Effect.Effect<I, ParseResult.ParseIssue, R3>;
@@ -3950,6 +4024,17 @@ type HasFields<Fields extends Struct.Fields> = Struct<Fields> | {
     readonly [RefineSchemaId]: HasFields<Fields>;
 };
 /**
+ * @example
+ * import { Schema } from "effect"
+ *
+ * class MyClass extends Schema.Class<MyClass>("MyClass")({
+ *  someField: Schema.String
+ * }) {
+ *  someMethod() {
+ *    return this.someField + "bar"
+ *  }
+ * }
+ *
  * @category classes
  * @since 3.10.0
  */
@@ -3962,6 +4047,13 @@ export interface TaggedClass<Self, Tag extends string, Fields extends Struct.Fie
     readonly _tag: Tag;
 }
 /**
+ * @example
+ * import { Schema } from "effect"
+ *
+ * class MyClass extends Schema.TaggedClass<MyClass>("MyClass")("MyClass", {
+ *  a: Schema.String
+ * }) {}
+ *
  * @category classes
  * @since 3.10.0
  */
@@ -3976,6 +4068,21 @@ export interface TaggedErrorClass<Self, Tag extends string, Fields extends Struc
     readonly _tag: Tag;
 }
 /**
+ * @example
+ * import { Schema } from "effect"
+ *
+ * class MyError extends Schema.TaggedError<MyError>("MyError")(
+ *   "MyError",
+ *   {
+ *     module: Schema.String,
+ *     method: Schema.String,
+ *     description: Schema.String
+ *   }
+ * ) {
+ *   get message(): string {
+ *     return `${this.module}.${this.method}: ${this.description}`
+ *   }
+ * }
  * @category classes
  * @since 3.10.0
  */
@@ -4542,6 +4649,15 @@ export interface TaggedRequestClass<Self, Tag extends string, Payload extends St
     readonly failure: Failure;
 }
 /**
+ * @example
+ * import { Schema } from "effect"
+ *
+ * class MyRequest extends Schema.TaggedRequest<MyRequest>("MyRequest")("MyRequest", {
+ *  failure: Schema.String,
+ *  success: Schema.Number,
+ *  payload: { id: Schema.String }
+ * }) {}
+ *
  * @category classes
  * @since 3.10.0
  */