TaggedRequestClass

Defined in: node_modules/.pnpm/effect@3.14.8/node_modules/effect/dist/dts/Schema.d.ts:5035

Since

3.10.0

Extends

Class<Self, Payload, Encoded<Payload>, Context<Payload>, Constructor<Omit<Payload, "_tag">>, TaggedRequest<Tag, Self, Encoded<Payload>, Context<Payload>, Type<Success>, Encoded<Success>, Type<Failure>, Encoded<Failure>, Context<Success> | Context<Failure>>, {}>

Type Parameters

• Self

• Tag extends string

• Payload extends Fields

• Success extends All

• Failure extends All

Constructors

new TaggedRequestClass()

new TaggedRequestClass(props, options?): Type<Payload> & TaggedRequest<Tag, Self, Encoded<Payload>, Context<Payload[keyof Payload]>, Type<Success>, Encoded<Success>, Type<Failure>, Encoded<Failure>, Context<Success> | Context<Failure>>

Defined in: node_modules/.pnpm/effect@3.14.8/node_modules/effect/dist/dts/Schema.d.ts:5035

Parameters

props

RequiredKeys<Constructor<Omit<Payload, "_tag">>> extends never ? void | { [K in string | number | symbol]: Constructor<Omit<Payload, “_tag”>>[K] } : { [K in string | number | symbol]: Constructor<Omit<Payload, “_tag”>>[K] }

options?

MakeOptions

Returns

Type<Payload> & TaggedRequest<Tag, Self, Encoded<Payload>, Context<Payload[keyof Payload]>, Type<Success>, Encoded<Success>, Type<Failure>, Encoded<Failure>, Context<Success> | Context<Failure>>

Inherited from

Class.constructor

Properties

_tag

readonly _tag: Tag

Defined in: node_modules/.pnpm/effect@3.14.8/node_modules/effect/dist/dts/Schema.d.ts:5036

[TypeId]

readonly [TypeId]: object

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

_A

readonly _A: Invariant<Self>

_I

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

_R

readonly _R: Covariant<Context<Payload[keyof Payload]>>

Inherited from

Class.[TypeId]

ast

readonly ast: Transformation

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

Since

3.10.0

Inherited from

Class.ast

Context

readonly Context: Context

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

Inherited from

Class.Context

Encoded

readonly Encoded: { [K in string | number | symbol]: Encoded<Payload>[K] }

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

Inherited from

Class.Encoded

failure

readonly failure: Failure

Defined in: node_modules/.pnpm/effect@3.14.8/node_modules/effect/dist/dts/Schema.d.ts:5038

fields

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

Defined in: node_modules/.pnpm/effect@3.14.8/node_modules/effect/dist/dts/Schema.d.ts:4272

Inherited from

Class.fields

identifier

readonly identifier: string

Defined in: node_modules/.pnpm/effect@3.14.8/node_modules/effect/dist/dts/Schema.d.ts:4275

Inherited from

Class.identifier

success

readonly success: Success

Defined in: node_modules/.pnpm/effect@3.14.8/node_modules/effect/dist/dts/Schema.d.ts:5037

Type

readonly Type: Self

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

Inherited from

Class.Type

Methods

annotations()

annotations(annotations): SchemaClass<Self, { [K in string | number | symbol]: Encoded<Payload>[K] }, Context<Payload[keyof Payload]>>

Defined in: node_modules/.pnpm/effect@3.14.8/node_modules/effect/dist/dts/Schema.d.ts:4271

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]: Encoded<Payload>[K] }, Context<Payload[keyof Payload]>>

Inherited from

Class.annotations

extend()

extend<Extended>(identifier): <NewFields>(fields, annotations?) => [Extended] extends [never] ? "Missing `Self` generic - use `class Self extends Base.extend<Self>()({ ... })`" : Class<Extended, Payload & NewFields, { readonly [K in string | number | symbol as Key<Payload, K>]: Encoded<Payload[K]> } & { readonly [K in string | number | symbol as Key<Payload, K>]?: Encoded<Payload[K]> } & { 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]> }, Context<Payload[keyof Payload]> | Context<NewFields[keyof NewFields]>, Constructor<Omit<Payload, "_tag">> & Constructor<NewFields>, Self, {}>

Defined in: node_modules/.pnpm/effect@3.14.8/node_modules/effect/dist/dts/Schema.d.ts:4298

Type Parameters

• Extended = never

Parameters

identifier

string

Returns

Function

Type Parameters

• NewFields extends Fields

Parameters

fields

NewFields | HasFields<NewFields>

annotations?

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

Returns

[Extended] extends [never] ? "Missing `Self` generic - use `class Self extends Base.extend<Self>()({ ... })`" : Class<Extended, Payload & NewFields, { readonly [K in string | number | symbol as Key<Payload, K>]: Encoded<Payload[K]> } & { readonly [K in string | number | symbol as Key<Payload, K>]?: Encoded<Payload[K]> } & { 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]> }, Context<Payload[keyof Payload]> | Context<NewFields[keyof NewFields]>, Constructor<Omit<Payload, "_tag">> & Constructor<NewFields>, Self, {}>

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

Inherited from

Class.extend

make()

make<Args, X>(this, …args): X

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

Type Parameters

• Args extends any[]

• X

Parameters

this

(…args) => X

args

…Args

Returns

X

Inherited from

Class.make

pipe()

Call Signature

pipe<A>(this): A

Defined in: node_modules/.pnpm/effect@3.14.8/node_modules/effect/dist/dts/Pipeable.d.ts:9

Type Parameters

• A

Parameters

this

A

Returns

A

Inherited from

Class.pipe

Call Signature

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

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

Type Parameters

• A

• B = never

Parameters

this

A

ab

(_) => B

Returns

B

Inherited from

Class.pipe

Call Signature

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

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

Type Parameters

• A

• B = never

• C = never

Parameters

this

A

ab

(_) => B

bc

(_) => C

Returns

C

Inherited from

Class.pipe

Call Signature

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

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

Type Parameters

• A

• B = never

• C = never

• D = never

Parameters

this

A

ab

(_) => B

bc

(_) => C

cd

(_) => D

Returns

D

Inherited from

Class.pipe

Call Signature

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

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

Type Parameters

• A

• B = never

• C = never

• D = never

• E = never

Parameters

this

A

ab

(_) => B

bc

(_) => C

cd

(_) => D

de

(_) => E

Returns

E

Inherited from

Class.pipe

Call Signature

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

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

Type Parameters

• A

• B = never

• C = never

• D = never

• E = never

• F = never

Parameters

this

A

ab

(_) => B

bc

(_) => C

cd

(_) => D

de

(_) => E

ef

(_) => F

Returns

F

Inherited from

Class.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.14.8/node_modules/effect/dist/dts/Pipeable.d.ts:15

Type Parameters

• A

• B = never

• C = never

• D = never

• E = never

• F = never

• G = never

Parameters

this

A

ab

(_) => B

bc

(_) => C

cd

(_) => D

de

(_) => E

ef

(_) => F

fg

(_) => G

Returns

G

Inherited from

Class.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.14.8/node_modules/effect/dist/dts/Pipeable.d.ts:16

Type Parameters

• A

• B = never

• C = never

• D = never

• E = never

• F = never

• G = never

• H = never

Parameters

this

A

ab

(_) => B

bc

(_) => C

cd

(_) => D

de

(_) => E

ef

(_) => F

fg

(_) => G

gh

(_) => H

Returns

H

Inherited from

Class.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.14.8/node_modules/effect/dist/dts/Pipeable.d.ts:17

Type Parameters

• A

• B = never

• C = never

• D = never

• E = never

• F = never

• G = never

• H = never

• 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

Class.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.14.8/node_modules/effect/dist/dts/Pipeable.d.ts:18

Type Parameters

• A

• B = never

• C = never

• D = never

• E = never

• F = never

• G = never

• H = never

• I = never

• 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

Class.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.14.8/node_modules/effect/dist/dts/Pipeable.d.ts:19

Type Parameters

• A

• B = never

• C = never

• D = never

• E = never

• F = never

• G = never

• H = never

• I = never

• J = never

• 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

Class.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.14.8/node_modules/effect/dist/dts/Pipeable.d.ts:20

Type Parameters

• A

• B = never

• C = never

• D = never

• E = never

• F = never

• G = never

• H = never

• I = never

• J = never

• K = never

• 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

Class.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.14.8/node_modules/effect/dist/dts/Pipeable.d.ts:21

Type Parameters

• A

• B = never

• C = never

• D = never

• E = never

• F = never

• G = never

• H = never

• I = never

• J = never

• K = never

• L = never

• 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

Class.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.14.8/node_modules/effect/dist/dts/Pipeable.d.ts:22

Type Parameters

• A

• B = never

• C = never

• D = never

• E = never

• F = never

• G = never

• H = never

• I = never

• J = never

• K = never

• L = never

• M = never

• 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

Class.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.14.8/node_modules/effect/dist/dts/Pipeable.d.ts:23

Type Parameters

• A

• B = never

• C = never

• D = never

• E = never

• F = never

• G = never

• H = never

• I = never

• J = never

• K = never

• L = never

• M = never

• N = never

• 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

Class.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.14.8/node_modules/effect/dist/dts/Pipeable.d.ts:24

Type Parameters

• A

• B = never

• C = never

• D = never

• E = never

• F = never

• G = never

• H = never

• I = never

• J = never

• K = never

• L = never

• M = never

• N = never

• O = never

• 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

Class.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.14.8/node_modules/effect/dist/dts/Pipeable.d.ts:25

Type Parameters

• A

• B = never

• C = never

• D = never

• E = never

• F = never

• G = never

• H = never

• I = never

• J = never

• K = never

• L = never

• M = never

• N = never

• O = never

• P = never

• 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

Class.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.14.8/node_modules/effect/dist/dts/Pipeable.d.ts:26

Type Parameters

• A

• B = never

• C = never

• D = never

• E = never

• F = never

• G = never

• H = never

• I = never

• J = never

• K = never

• L = never

• M = never

• N = never

• O = never

• P = never

• Q = never

• 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

Class.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.14.8/node_modules/effect/dist/dts/Pipeable.d.ts:27

Type Parameters

• A

• B = never

• C = never

• D = never

• E = never

• F = never

• G = never

• H = never

• I = never

• J = never

• K = never

• L = never

• M = never

• N = never

• O = never

• P = never

• Q = never

• R = never

• 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

Class.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.14.8/node_modules/effect/dist/dts/Pipeable.d.ts:28

Type Parameters

• A

• B = never

• C = never

• D = never

• E = never

• F = never

• G = never

• H = never

• I = never

• J = never

• K = never

• L = never

• M = never

• N = never

• O = never

• P = never

• Q = never

• R = never

• S = never

• 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

Class.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.14.8/node_modules/effect/dist/dts/Pipeable.d.ts:29

Type Parameters

• A

• B = never

• C = never

• D = never

• E = never

• F = never

• G = never

• H = never

• I = never

• J = never

• K = never

• L = never

• M = never

• N = never

• O = never

• P = never

• Q = never

• R = never

• S = never

• T = never

• 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

Class.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.14.8/node_modules/effect/dist/dts/Pipeable.d.ts:30

Type Parameters

• A

• B = never

• C = never

• D = never

• E = never

• F = never

• G = never

• H = never

• I = never

• J = never

• K = never

• L = never

• M = never

• N = never

• O = never

• P = never

• Q = never

• R = never

• S = never

• T = never

• 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

Class.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, Payload & NewFields, Encoded<Payload>, Context<Payload[keyof Payload]> | R2 | R3 | Context<NewFields[keyof NewFields]>, Constructor<Omit<Payload, "_tag">> & Constructor<NewFields>, Self, {}>

Defined in: node_modules/.pnpm/effect@3.14.8/node_modules/effect/dist/dts/Schema.d.ts:4328

Type Parameters

• Transformed = never

Parameters

identifier

string

Returns

Function

Type Parameters

• NewFields extends Fields

• R2

• R3

Parameters

fields

NewFields

options

decode

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

encode

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

annotations?

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

Returns

[Transformed] extends [never] ? "Missing `Self` generic - use `class Self extends Base.transformOrFail<Self>()({ ... })`" : Class<Transformed, Payload & NewFields, Encoded<Payload>, Context<Payload[keyof Payload]> | R2 | R3 | Context<NewFields[keyof NewFields]>, Constructor<Omit<Payload, "_tag">> & Constructor<NewFields>, Self, {}>

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

Inherited from

Class.transformOrFail

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, Payload & NewFields, Encoded<Payload>, Context<Payload[keyof Payload]> | R2 | R3 | Context<NewFields[keyof NewFields]>, Constructor<Omit<Payload, "_tag">> & Constructor<NewFields>, Self, {}>

Defined in: node_modules/.pnpm/effect@3.14.8/node_modules/effect/dist/dts/Schema.d.ts:4361

Type Parameters

• Transformed = never

Parameters

identifier

string

Returns

Function

Type Parameters

• NewFields extends Fields

• R2

• R3

Parameters

fields

NewFields

options

decode

(input, options, ast) => Effect<{ [K in string | number | symbol]: ({ readonly [K in string | number | symbol as Key<Payload, K>]: Encoded<Payload[K]> } & { readonly [K in string | number | symbol as Key<Payload, K>]?: Encoded<(…)[(…)]> } & { 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<Encoded<Payload>, ParseIssue, R3>

annotations?

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

Returns

[Transformed] extends [never] ? "Missing `Self` generic - use `class Self extends Base.transformOrFailFrom<Self>()({ ... })`" : Class<Transformed, Payload & NewFields, Encoded<Payload>, Context<Payload[keyof Payload]> | R2 | R3 | Context<NewFields[keyof NewFields]>, Constructor<Omit<Payload, "_tag">> & Constructor<NewFields>, Self, {}>

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

Inherited from

Class.transformOrFailFrom