Class

Defined in: node_modules/.pnpm/effect@3.15.2/node_modules/effect/dist/dts/Schema.d.ts:4264

Since

3.10.0

Extends

Schema<Self, Simplify<I>, R>

Extended by

Type Parameters

Self

Self

Fields

Fields extends Fields

I

I

R

R

C

C

Inherited

Inherited

Proto

Proto

Constructors

Constructor

new Class(props, options?): Type<Fields> & Inherited & Proto

Defined in: node_modules/.pnpm/effect@3.15.2/node_modules/effect/dist/dts/Schema.d.ts:4265

Parameters

props

RequiredKeys<C> extends never ? void | { [K in string | number | symbol]: C[K] } : { [K in string | number | symbol]: C[K] }

options?

MakeOptions

Returns

Type<Fields> & Inherited & Proto

Inherited from

Schema<Self, Simplify<I>, R>.constructor

Properties

[TypeId]

readonly [TypeId]: object

Defined in: node_modules/.pnpm/effect@3.15.2/node_modules/effect/dist/dts/Schema.d.ts:160

_A

readonly _A: Invariant<Self>

_I

readonly _I: Invariant<{ [K in string | number | symbol]: I[K] }>

_R

readonly _R: Covariant<R>

Inherited from

Schema.[TypeId]

ast

readonly ast: Transformation

Defined in: node_modules/.pnpm/effect@3.15.2/node_modules/effect/dist/dts/Schema.d.ts:4267

Since

3.10.0

Overrides

Schema.ast

Context

readonly Context: R

Defined in: node_modules/.pnpm/effect@3.15.2/node_modules/effect/dist/dts/Schema.d.ts:63

Inherited from

Schema.Context

Encoded

readonly Encoded: { [K in string | number | symbol]: I[K] }

Defined in: node_modules/.pnpm/effect@3.15.2/node_modules/effect/dist/dts/Schema.d.ts:62

Inherited from

Schema.Encoded

fields

readonly fields: { readonly [K in string | number | symbol]: Fields[K] }

Defined in: node_modules/.pnpm/effect@3.15.2/node_modules/effect/dist/dts/Schema.d.ts:4270

identifier

readonly identifier: string

Defined in: node_modules/.pnpm/effect@3.15.2/node_modules/effect/dist/dts/Schema.d.ts:4273

Type

readonly Type: Self

Defined in: node_modules/.pnpm/effect@3.15.2/node_modules/effect/dist/dts/Schema.d.ts:61

Inherited from

Schema.Type

Methods

annotations()

annotations(annotations): SchemaClass<Self, { [K in string | number | symbol]: I[K] }, R>

Defined in: node_modules/.pnpm/effect@3.15.2/node_modules/effect/dist/dts/Schema.d.ts:4269

Merges a set of new annotations with existing ones, potentially overwriting any duplicates.

Parameters

annotations

Schema<Self>

Returns

SchemaClass<Self, { [K in string | number | symbol]: I[K] }, R>

Overrides

Schema.annotations

extend()

extend<Extended>(identifier): <NewFields>(fields, annotations?) => [Extended] extends [never] ? "Missing `Self` generic - use `class Self extends Base.extend<Self>()({ ... })`" : Class<Extended, Fields & NewFields, I & { readonly [K in string | number | symbol as Key<NewFields, K>]: Encoded<NewFields[K]> } & { readonly [K in string | number | symbol as Key<NewFields, K>]?: Encoded<NewFields[K]> }, R | Context<NewFields[keyof NewFields]>, C & Constructor<NewFields>, Self, Proto>

Defined in: node_modules/.pnpm/effect@3.15.2/node_modules/effect/dist/dts/Schema.d.ts:4296

Type Parameters

Extended

Extended = never

Parameters

identifier

string

Returns

<NewFields>(fields, annotations?): [Extended] extends [never] ? "Missing `Self` generic - use `class Self extends Base.extend<Self>()({ ... })`" : Class<Extended, Fields & NewFields, I & { readonly [K in string | number | symbol as Key<NewFields, K>]: Encoded<NewFields[K]> } & { readonly [K in string | number | symbol as Key<NewFields, K>]?: Encoded<NewFields[K]> }, R | Context<NewFields[keyof NewFields]>, C & Constructor<NewFields>, Self, Proto>

Type Parameters

NewFields

NewFields extends Fields

Parameters

fields

NewFields | HasFields<NewFields>

annotations?

ClassAnnotations<Extended, { [K in string | number | symbol]: Type<Fields & NewFields>[K] }>

Returns

[Extended] extends [never] ? "Missing `Self` generic - use `class Self extends Base.extend<Self>()({ ... })`" : Class<Extended, Fields & NewFields, I & { readonly [K in string | number | symbol as Key<NewFields, K>]: Encoded<NewFields[K]> } & { readonly [K in string | number | symbol as Key<NewFields, K>]?: Encoded<NewFields[K]> }, R | Context<NewFields[keyof NewFields]>, C & Constructor<NewFields>, Self, Proto>

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
 }
}

make()

make<C>(this, …args): InstanceType<C>

Defined in: node_modules/.pnpm/effect@3.15.2/node_modules/effect/dist/dts/Schema.d.ts:4268

Type Parameters

C

C extends (…args) => any

Parameters

this

C

args

…ConstructorParameters<C>

Returns

InstanceType<C>

pipe()

Call Signature

pipe<A>(this): A

Defined in: node_modules/.pnpm/effect@3.15.2/node_modules/effect/dist/dts/Pipeable.d.ts:10

Type Parameters

A

A

Parameters

this

A

Returns

A

Inherited from

Schema.pipe

Call Signature

pipe<A, B>(this, ab): B

Defined in: node_modules/.pnpm/effect@3.15.2/node_modules/effect/dist/dts/Pipeable.d.ts:11

Type Parameters

A

A

B

B = never

Parameters

this

A

ab

(_) => B

Returns

B

Inherited from

Schema.pipe

Call Signature

pipe<A, B, C>(this, ab, bc): C

Defined in: node_modules/.pnpm/effect@3.15.2/node_modules/effect/dist/dts/Pipeable.d.ts:12

Type Parameters

A

A

B

B = never

C

C = never

Parameters

this

A

ab

(_) => B

bc

(_) => C

Returns

C

Inherited from

Schema.pipe

Call Signature

pipe<A, B, C, D>(this, ab, bc, cd): D

Defined in: node_modules/.pnpm/effect@3.15.2/node_modules/effect/dist/dts/Pipeable.d.ts:13

Type Parameters

A

A

B

B = never

C

C = never

D

D = never

Parameters

this

A

ab

(_) => B

bc

(_) => C

cd

(_) => D

Returns

D

Inherited from

Schema.pipe

Call Signature

pipe<A, B, C, D, E>(this, ab, bc, cd, de): E

Defined in: node_modules/.pnpm/effect@3.15.2/node_modules/effect/dist/dts/Pipeable.d.ts:14

Type Parameters

A

A

B

B = never

C

C = never

D

D = never

E

E = never

Parameters

this

A

ab

(_) => B

bc

(_) => C

cd

(_) => D

de

(_) => E

Returns

E

Inherited from

Schema.pipe

Call Signature

pipe<A, B, C, D, E, F>(this, ab, bc, cd, de, ef): F

Defined in: node_modules/.pnpm/effect@3.15.2/node_modules/effect/dist/dts/Pipeable.d.ts:15

Type Parameters

A

A

B

B = never

C

C = never

D

D = never

E

E = never

F

F = never

Parameters

this

A

ab

(_) => B

bc

(_) => C

cd

(_) => D

de

(_) => E

ef

(_) => F

Returns

F

Inherited from

Schema.pipe

Call Signature

pipe<A, B, C, D, E, F, G>(this, ab, bc, cd, de, ef, fg): G

Defined in: node_modules/.pnpm/effect@3.15.2/node_modules/effect/dist/dts/Pipeable.d.ts:16

Type Parameters

A

A

B

B = never

C

C = never

D

D = never

E

E = never

F

F = never

G

G = never

Parameters

this

A

ab

(_) => B

bc

(_) => C

cd

(_) => D

de

(_) => E

ef

(_) => F

fg

(_) => G

Returns

G

Inherited from

Schema.pipe

Call Signature

pipe<A, B, C, D, E, F, G, H>(this, ab, bc, cd, de, ef, fg, gh): H

Defined in: node_modules/.pnpm/effect@3.15.2/node_modules/effect/dist/dts/Pipeable.d.ts:17

Type Parameters

A

A

B

B = never

C

C = never

D

D = never

E

E = never

F

F = never

G

G = never

H

H = never

Parameters

this

A

ab

(_) => B

bc

(_) => C

cd

(_) => D

de

(_) => E

ef

(_) => F

fg

(_) => G

gh

(_) => H

Returns

H

Inherited from

Schema.pipe

Call Signature

pipe<A, B, C, D, E, F, G, H, I>(this, ab, bc, cd, de, ef, fg, gh, hi): I

Defined in: node_modules/.pnpm/effect@3.15.2/node_modules/effect/dist/dts/Pipeable.d.ts:18

Type Parameters

A

A

B

B = never

C

C = never

D

D = never

E

E = never

F

F = never

G

G = never

H

H = never

I

I = never

Parameters

this

A

ab

(_) => B

bc

(_) => C

cd

(_) => D

de

(_) => E

ef

(_) => F

fg

(_) => G

gh

(_) => H

hi

(_) => I

Returns

I

Inherited from

Schema.pipe

Call Signature

pipe<A, B, C, D, E, F, G, H, I, J>(this, ab, bc, cd, de, ef, fg, gh, hi, ij): J

Defined in: node_modules/.pnpm/effect@3.15.2/node_modules/effect/dist/dts/Pipeable.d.ts:19

Type Parameters

A

A

B

B = never

C

C = never

D

D = never

E

E = never

F

F = never

G

G = never

H

H = never

I

I = never

J

J = never

Parameters

this

A

ab

(_) => B

bc

(_) => C

cd

(_) => D

de

(_) => E

ef

(_) => F

fg

(_) => G

gh

(_) => H

hi

(_) => I

ij

(_) => J

Returns

J

Inherited from

Schema.pipe

Call Signature

pipe<A, B, C, D, E, F, G, H, I, J, K>(this, ab, bc, cd, de, ef, fg, gh, hi, ij, jk): K

Defined in: node_modules/.pnpm/effect@3.15.2/node_modules/effect/dist/dts/Pipeable.d.ts:20

Type Parameters

A

A

B

B = never

C

C = never

D

D = never

E

E = never

F

F = never

G

G = never

H

H = never

I

I = never

J

J = never

K

K = never

Parameters

this

A

ab

(_) => B

bc

(_) => C

cd

(_) => D

de

(_) => E

ef

(_) => F

fg

(_) => G

gh

(_) => H

hi

(_) => I

ij

(_) => J

jk

(_) => K

Returns

K

Inherited from

Schema.pipe

Call Signature

pipe<A, B, C, D, E, F, G, H, I, J, K, L>(this, ab, bc, cd, de, ef, fg, gh, hi, ij, jk, kl): L

Defined in: node_modules/.pnpm/effect@3.15.2/node_modules/effect/dist/dts/Pipeable.d.ts:21

Type Parameters

A

A

B

B = never

C

C = never

D

D = never

E

E = never

F

F = never

G

G = never

H

H = never

I

I = never

J

J = never

K

K = never

L

L = never

Parameters

this

A

ab

(_) => B

bc

(_) => C

cd

(_) => D

de

(_) => E

ef

(_) => F

fg

(_) => G

gh

(_) => H

hi

(_) => I

ij

(_) => J

jk

(_) => K

kl

(_) => L

Returns

L

Inherited from

Schema.pipe

Call Signature

pipe<A, B, C, D, E, F, G, H, I, J, K, L, M>(this, ab, bc, cd, de, ef, fg, gh, hi, ij, jk, kl, lm): M

Defined in: node_modules/.pnpm/effect@3.15.2/node_modules/effect/dist/dts/Pipeable.d.ts:22

Type Parameters

A

A

B

B = never

C

C = never

D

D = never

E

E = never

F

F = never

G

G = never

H

H = never

I

I = never

J

J = never

K

K = never

L

L = never

M

M = never

Parameters

this

A

ab

(_) => B

bc

(_) => C

cd

(_) => D

de

(_) => E

ef

(_) => F

fg

(_) => G

gh

(_) => H

hi

(_) => I

ij

(_) => J

jk

(_) => K

kl

(_) => L

lm

(_) => M

Returns

M

Inherited from

Schema.pipe

Call Signature

pipe<A, B, C, D, E, F, G, H, I, J, K, L, M, N>(this, ab, bc, cd, de, ef, fg, gh, hi, ij, jk, kl, lm, mn): N

Defined in: node_modules/.pnpm/effect@3.15.2/node_modules/effect/dist/dts/Pipeable.d.ts:23

Type Parameters

A

A

B

B = never

C

C = never

D

D = never

E

E = never

F

F = never

G

G = never

H

H = never

I

I = never

J

J = never

K

K = never

L

L = never

M

M = never

N

N = never

Parameters

this

A

ab

(_) => B

bc

(_) => C

cd

(_) => D

de

(_) => E

ef

(_) => F

fg

(_) => G

gh

(_) => H

hi

(_) => I

ij

(_) => J

jk

(_) => K

kl

(_) => L

lm

(_) => M

mn

(_) => N

Returns

N

Inherited from

Schema.pipe

Call Signature

pipe<A, B, C, D, E, F, G, H, I, J, K, L, M, N, O>(this, ab, bc, cd, de, ef, fg, gh, hi, ij, jk, kl, lm, mn, no): O

Defined in: node_modules/.pnpm/effect@3.15.2/node_modules/effect/dist/dts/Pipeable.d.ts:24

Type Parameters

A

A

B

B = never

C

C = never

D

D = never

E

E = never

F

F = never

G

G = never

H

H = never

I

I = never

J

J = never

K

K = never

L

L = never

M

M = never

N

N = never

O

O = never

Parameters

this

A

ab

(_) => B

bc

(_) => C

cd

(_) => D

de

(_) => E

ef

(_) => F

fg

(_) => G

gh

(_) => H

hi

(_) => I

ij

(_) => J

jk

(_) => K

kl

(_) => L

lm

(_) => M

mn

(_) => N

no

(_) => O

Returns

O

Inherited from

Schema.pipe

Call Signature

pipe<A, B, C, D, E, F, G, H, I, J, K, L, M, N, O, P>(this, ab, bc, cd, de, ef, fg, gh, hi, ij, jk, kl, lm, mn, no, op): P

Defined in: node_modules/.pnpm/effect@3.15.2/node_modules/effect/dist/dts/Pipeable.d.ts:25

Type Parameters

A

A

B

B = never

C

C = never

D

D = never

E

E = never

F

F = never

G

G = never

H

H = never

I

I = never

J

J = never

K

K = never

L

L = never

M

M = never

N

N = never

O

O = never

P

P = never

Parameters

this

A

ab

(_) => B

bc

(_) => C

cd

(_) => D

de

(_) => E

ef

(_) => F

fg

(_) => G

gh

(_) => H

hi

(_) => I

ij

(_) => J

jk

(_) => K

kl

(_) => L

lm

(_) => M

mn

(_) => N

no

(_) => O

op

(_) => P

Returns

P

Inherited from

Schema.pipe

Call Signature

pipe<A, B, C, D, E, F, G, H, I, J, K, L, M, N, O, P, Q>(this, ab, bc, cd, de, ef, fg, gh, hi, ij, jk, kl, lm, mn, no, op, pq): Q

Defined in: node_modules/.pnpm/effect@3.15.2/node_modules/effect/dist/dts/Pipeable.d.ts:26

Type Parameters

A

A

B

B = never

C

C = never

D

D = never

E

E = never

F

F = never

G

G = never

H

H = never

I

I = never

J

J = never

K

K = never

L

L = never

M

M = never

N

N = never

O

O = never

P

P = never

Q

Q = never

Parameters

this

A

ab

(_) => B

bc

(_) => C

cd

(_) => D

de

(_) => E

ef

(_) => F

fg

(_) => G

gh

(_) => H

hi

(_) => I

ij

(_) => J

jk

(_) => K

kl

(_) => L

lm

(_) => M

mn

(_) => N

no

(_) => O

op

(_) => P

pq

(_) => Q

Returns

Q

Inherited from

Schema.pipe

Call Signature

pipe<A, B, C, D, E, F, G, H, I, J, K, L, M, N, O, P, Q, R>(this, ab, bc, cd, de, ef, fg, gh, hi, ij, jk, kl, lm, mn, no, op, pq, qr): R

Defined in: node_modules/.pnpm/effect@3.15.2/node_modules/effect/dist/dts/Pipeable.d.ts:27

Type Parameters

A

A

B

B = never

C

C = never

D

D = never

E

E = never

F

F = never

G

G = never

H

H = never

I

I = never

J

J = never

K

K = never

L

L = never

M

M = never

N

N = never

O

O = never

P

P = never

Q

Q = never

R

R = never

Parameters

this

A

ab

(_) => B

bc

(_) => C

cd

(_) => D

de

(_) => E

ef

(_) => F

fg

(_) => G

gh

(_) => H

hi

(_) => I

ij

(_) => J

jk

(_) => K

kl

(_) => L

lm

(_) => M

mn

(_) => N

no

(_) => O

op

(_) => P

pq

(_) => Q

qr

(_) => R

Returns

R

Inherited from

Schema.pipe

Call Signature

pipe<A, B, C, D, E, F, G, H, I, J, K, L, M, N, O, P, Q, R, S>(this, ab, bc, cd, de, ef, fg, gh, hi, ij, jk, kl, lm, mn, no, op, pq, qr, rs): S

Defined in: node_modules/.pnpm/effect@3.15.2/node_modules/effect/dist/dts/Pipeable.d.ts:28

Type Parameters

A

A

B

B = never

C

C = never

D

D = never

E

E = never

F

F = never

G

G = never

H

H = never

I

I = never

J

J = never

K

K = never

L

L = never

M

M = never

N

N = never

O

O = never

P

P = never

Q

Q = never

R

R = never

S

S = never

Parameters

this

A

ab

(_) => B

bc

(_) => C

cd

(_) => D

de

(_) => E

ef

(_) => F

fg

(_) => G

gh

(_) => H

hi

(_) => I

ij

(_) => J

jk

(_) => K

kl

(_) => L

lm

(_) => M

mn

(_) => N

no

(_) => O

op

(_) => P

pq

(_) => Q

qr

(_) => R

rs

(_) => S

Returns

S

Inherited from

Schema.pipe

Call Signature

pipe<A, B, C, D, E, F, G, H, I, J, K, L, M, N, O, P, Q, R, S, T>(this, ab, bc, cd, de, ef, fg, gh, hi, ij, jk, kl, lm, mn, no, op, pq, qr, rs, st): T

Defined in: node_modules/.pnpm/effect@3.15.2/node_modules/effect/dist/dts/Pipeable.d.ts:29

Type Parameters

A

A

B

B = never

C

C = never

D

D = never

E

E = never

F

F = never

G

G = never

H

H = never

I

I = never

J

J = never

K

K = never

L

L = never

M

M = never

N

N = never

O

O = never

P

P = never

Q

Q = never

R

R = never

S

S = never

T

T = never

Parameters

this

A

ab

(_) => B

bc

(_) => C

cd

(_) => D

de

(_) => E

ef

(_) => F

fg

(_) => G

gh

(_) => H

hi

(_) => I

ij

(_) => J

jk

(_) => K

kl

(_) => L

lm

(_) => M

mn

(_) => N

no

(_) => O

op

(_) => P

pq

(_) => Q

qr

(_) => R

rs

(_) => S

st

(_) => T

Returns

T

Inherited from

Schema.pipe

Call Signature

pipe<A, B, C, D, E, F, G, H, I, J, K, L, M, N, O, P, Q, R, S, T, U>(this, ab, bc, cd, de, ef, fg, gh, hi, ij, jk, kl, lm, mn, no, op, pq, qr, rs, st, tu): U

Defined in: node_modules/.pnpm/effect@3.15.2/node_modules/effect/dist/dts/Pipeable.d.ts:30

Type Parameters

A

A

B

B = never

C

C = never

D

D = never

E

E = never

F

F = never

G

G = never

H

H = never

I

I = never

J

J = never

K

K = never

L

L = never

M

M = never

N

N = never

O

O = never

P

P = never

Q

Q = never

R

R = never

S

S = never

T

T = never

U

U = never

Parameters

this

A

ab

(_) => B

bc

(_) => C

cd

(_) => D

de

(_) => E

ef

(_) => F

fg

(_) => G

gh

(_) => H

hi

(_) => I

ij

(_) => J

jk

(_) => K

kl

(_) => L

lm

(_) => M

mn

(_) => N

no

(_) => O

op

(_) => P

pq

(_) => Q

qr

(_) => R

rs

(_) => S

st

(_) => T

tu

(_) => U

Returns

U

Inherited from

Schema.pipe

Call Signature

pipe<A, B, C, D, E, F, G, H, I, J, K, L, M, N, O, P, Q, R, S, T, U>(this, ab, bc, cd, de, ef, fg, gh, hi, ij, jk, kl, lm, mn, no, op, pq, qr, rs, st, tu): U

Defined in: node_modules/.pnpm/effect@3.15.2/node_modules/effect/dist/dts/Pipeable.d.ts:31

Type Parameters

A

A

B

B = never

C

C = never

D

D = never

E

E = never

F

F = never

G

G = never

H

H = never

I

I = never

J

J = never

K

K = never

L

L = never

M

M = never

N

N = never

O

O = never

P

P = never

Q

Q = never

R

R = never

S

S = never

T

T = never

U

U = never

Parameters

this

A

ab

(_) => B

bc

(_) => C

cd

(_) => D

de

(_) => E

ef

(_) => F

fg

(_) => G

gh

(_) => H

hi

(_) => I

ij

(_) => J

jk

(_) => K

kl

(_) => L

lm

(_) => M

mn

(_) => N

no

(_) => O

op

(_) => P

pq

(_) => Q

qr

(_) => R

rs

(_) => S

st

(_) => T

tu

(_) => U

Returns

U

Inherited from

Schema.pipe

transformOrFail()

transformOrFail<Transformed>(identifier): <NewFields, R2, R3>(fields, options, annotations?) => [Transformed] extends [never] ? "Missing `Self` generic - use `class Self extends Base.transformOrFail<Self>()({ ... })`" : Class<Transformed, Fields & NewFields, I, R | R2 | R3 | Context<NewFields[keyof NewFields]>, C & Constructor<NewFields>, Self, Proto>

Defined in: node_modules/.pnpm/effect@3.15.2/node_modules/effect/dist/dts/Schema.d.ts:4326

Type Parameters

Transformed

Transformed = never

Parameters

identifier

string

Returns

<NewFields, R2, R3>(fields, options, annotations?): [Transformed] extends [never] ? "Missing `Self` generic - use `class Self extends Base.transformOrFail<Self>()({ ... })`" : Class<Transformed, Fields & NewFields, I, R | R2 | R3 | Context<NewFields[keyof NewFields]>, C & Constructor<NewFields>, Self, Proto>

Type Parameters

NewFields

NewFields extends Fields

R2

R2

R3

R3

Parameters

fields

NewFields

options

decode

(input, options, ast) => Effect<{ [K in string | number | symbol]: Type<Fields & NewFields>[K] }, ParseIssue, R2>

encode

(input, options, ast) => Effect<Type<Fields>, ParseIssue, R3>

annotations?

ClassAnnotations<Transformed, { [K in string | number | symbol]: Type<Fields & NewFields>[K] }>

Returns

[Transformed] extends [never] ? "Missing `Self` generic - use `class Self extends Base.transformOrFail<Self>()({ ... })`" : Class<Transformed, Fields & NewFields, I, R | R2 | R3 | Context<NewFields[keyof NewFields]>, C & 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
  }
}

transformOrFailFrom()

transformOrFailFrom<Transformed>(identifier): <NewFields, R2, R3>(fields, options, annotations?) => [Transformed] extends [never] ? "Missing `Self` generic - use `class Self extends Base.transformOrFailFrom<Self>()({ ... })`" : Class<Transformed, Fields & NewFields, I, R | R2 | R3 | Context<NewFields[keyof NewFields]>, C & Constructor<NewFields>, Self, Proto>

Defined in: node_modules/.pnpm/effect@3.15.2/node_modules/effect/dist/dts/Schema.d.ts:4359

Type Parameters

Transformed

Transformed = never

Parameters

identifier

string

Returns

<NewFields, R2, R3>(fields, options, annotations?): [Transformed] extends [never] ? "Missing `Self` generic - use `class Self extends Base.transformOrFailFrom<Self>()({ ... })`" : Class<Transformed, Fields & NewFields, I, R | R2 | R3 | Context<NewFields[keyof NewFields]>, C & Constructor<NewFields>, Self, Proto>

Type Parameters

NewFields

NewFields extends Fields

R2

R2

R3

R3

Parameters

fields

NewFields

options

decode

(input, options, ast) => Effect<{ [K in string | number | symbol]: (I & { readonly [K in string | number | symbol as Key<NewFields, K>]: Encoded<NewFields[K]> } & { readonly [K in string | number | symbol as Key<NewFields, K>]?: Encoded<(…)[(…)]> })[K] }, ParseIssue, R2>

encode

(input, options, ast) => Effect<I, ParseIssue, R3>

annotations?

ClassAnnotations<Transformed, { [K in string | number | symbol]: Type<Fields & NewFields>[K] }>

Returns

[Transformed] extends [never] ? "Missing `Self` generic - use `class Self extends Base.transformOrFailFrom<Self>()({ ... })`" : Class<Transformed, Fields & NewFields, I, R | R2 | R3 | Context<NewFields[keyof NewFields]>, C & 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
  }
}