InitialMessage

Defined in: packages/@livestore/adapter-web/src/web-worker/common/worker-schema.ts:59

Extends

object & object & object & object & object & object & object & TaggedRequest<"InitialMessage", InitialMessage, Encoded<object & object>, never, void, void, UnexpectedError, { _tag: "LiveStore.UnexpectedError"; cause: unknown; note?: string; payload?: any; }, never, this>

Constructors

Constructor

new InitialMessage(props, options?): InitialMessage

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

Parameters

props

clientId

string = Schema.String

debugInstanceId

string = Schema.String

devtoolsEnabled

boolean = Schema.Boolean

storageOptions

{ directory?: string; type: "opfs"; } = StorageType

storageOptions.directory?

string = ...

Default is livestore-${storeId}

When providing this option, make sure to include the storeId in the path to avoid conflicts with other LiveStore apps.

storageOptions.type

"opfs" = ...

storeId

string = Schema.String

syncPayload

undefined | JsonValue = ...

options?

MakeOptions

Returns

InitialMessage

Inherited from

Schema.TaggedRequest<InitialMessage>()('InitialMessage', { payload: { storageOptions: StorageType, devtoolsEnabled: Schema.Boolean, storeId: Schema.String, clientId: Schema.String, debugInstanceId: Schema.String, syncPayload: Schema.UndefinedOr(Schema.JsonValue), }, success: Schema.Void, failure: UnexpectedError, }).constructor

Properties

_tag

readonly _tag: "InitialMessage"

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

Inherited from

[RequestTypeId]

readonly [RequestTypeId]: object

Defined in: node_modules/.pnpm/effect@3.15.2/node_modules/effect/dist/dts/Request.d.ts:41

_A

readonly _A: Covariant<void>

_E

readonly _E: Covariant<UnexpectedError>

Inherited from

[symbolSerializable]

readonly [symbolSerializable]: Schema<InitialMessage, Encoded<object & object>, never>

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

Inherited from

[symbolWithResult]

readonly [symbolWithResult]: object

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

failure

readonly failure: Schema<UnexpectedError, { _tag: "LiveStore.UnexpectedError"; cause: unknown; note?: string; payload?: any; }, never>

success

readonly success: Schema<void, void, never>

Inherited from

clientId

readonly clientId: string = Schema.String

Defined in: packages/@livestore/adapter-web/src/web-worker/common/worker-schema.ts:64

Inherited from

debugInstanceId

readonly debugInstanceId: string = Schema.String

Defined in: packages/@livestore/adapter-web/src/web-worker/common/worker-schema.ts:65

Inherited from

devtoolsEnabled

readonly devtoolsEnabled: boolean = Schema.Boolean

Defined in: packages/@livestore/adapter-web/src/web-worker/common/worker-schema.ts:62

Inherited from

storageOptions

readonly storageOptions: object = StorageType

Defined in: packages/@livestore/adapter-web/src/web-worker/common/worker-schema.ts:61

directory?

readonly optional directory: string

Default is livestore-${storeId}

When providing this option, make sure to include the storeId in the path to avoid conflicts with other LiveStore apps.

type

readonly type: "opfs"

Inherited from

storeId

readonly storeId: string = Schema.String

Defined in: packages/@livestore/adapter-web/src/web-worker/common/worker-schema.ts:63

Inherited from

syncPayload

readonly syncPayload: undefined | JsonValue

Defined in: packages/@livestore/adapter-web/src/web-worker/common/worker-schema.ts:66

Inherited from

_tag

readonly static _tag: "InitialMessage"

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

Inherited from

[TypeId]

readonly static [TypeId]: object

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

_A

readonly _A: Invariant<InitialMessage>

_I

readonly _I: Invariant<{ _tag: "InitialMessage"; clientId: string; debugInstanceId: string; devtoolsEnabled: boolean; storageOptions: { directory?: string; type: "opfs"; }; storeId: string; syncPayload: undefined | JsonValue; }>

_R

readonly _R: Covariant<never>

Inherited from

ast

readonly static ast: Transformation

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

Since

3.10.0

Inherited from

Context

readonly static Context: never

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

Inherited from

Encoded

readonly static Encoded: object

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

_tag

_tag: "InitialMessage"

clientId

clientId: string

debugInstanceId

debugInstanceId: string

devtoolsEnabled

devtoolsEnabled: boolean

storageOptions

storageOptions: object

storageOptions.directory?

optional directory: string

storageOptions.type

type: "opfs"

storeId

storeId: string

syncPayload

syncPayload: undefined | JsonValue

Inherited from

failure

readonly static failure: typeof UnexpectedError

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

Inherited from

fields

readonly static fields: object

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

_tag

readonly _tag: tag<"InitialMessage">

clientId

readonly clientId: typeof String$ = Schema.String

debugInstanceId

readonly debugInstanceId: typeof String$ = Schema.String

devtoolsEnabled

readonly devtoolsEnabled: typeof Boolean$ = Schema.Boolean

storageOptions

readonly storageOptions: Struct<{ directory: optional<typeof String$>; type: Literal<["opfs"]>; }> = StorageType

storeId

readonly storeId: typeof String$ = Schema.String

syncPayload

readonly syncPayload: UndefinedOr<Schema<JsonValue, JsonValue, never>>

Inherited from

identifier

readonly static identifier: string

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

Inherited from

success

readonly static success: typeof Void

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

Inherited from

Type

readonly static Type: InitialMessage

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

Inherited from

Methods

annotations()

static annotations(annotations): SchemaClass<InitialMessage, { _tag: "InitialMessage"; clientId: string; debugInstanceId: string; devtoolsEnabled: boolean; storageOptions: { directory?: string; type: "opfs"; }; storeId: string; syncPayload: undefined | JsonValue; }, never>

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

Returns

SchemaClass<InitialMessage, { _tag: "InitialMessage"; clientId: string; debugInstanceId: string; devtoolsEnabled: boolean; storageOptions: { directory?: string; type: "opfs"; }; storeId: string; syncPayload: undefined | JsonValue; }, never>

Inherited from

extend()

static extend<Extended>(identifier): <NewFields>(fields, annotations?) => [Extended] extends [never] ? "Missing `Self` generic - use `class Self extends Base.extend<Self>()({ ... })`" : Class<Extended, object & object & NewFields, object & object & { 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<NewFields[keyof NewFields]>, object & object & object & object & object & object & Constructor<NewFields>, InitialMessage, { }>

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, object & object & NewFields, object & object & { 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<NewFields[keyof NewFields]>, object & object & object & object & object & object & Constructor<NewFields>, InitialMessage, { }>

Type Parameters

NewFields

NewFields extends Fields

Parameters

fields

NewFields | HasFields<NewFields>

annotations?

ClassAnnotations<Extended, { [K in string | number | symbol]: Type<{ _tag: tag<“InitialMessage”> } & { clientId: typeof String$; debugInstanceId: typeof String$; devtoolsEnabled: typeof Boolean$; storageOptions: Struct<{ directory: optional<(…)>; type: Literal<(…)> }>; storeId: typeof String$; syncPayload: UndefinedOr<Schema<JsonValue, JsonValue, never>> } & NewFields>[K] }>

Returns

[Extended] extends [never] ? "Missing `Self` generic - use `class Self extends Base.extend<Self>()({ ... })`" : Class<Extended, object & object & NewFields, object & object & { 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<NewFields[keyof NewFields]>, object & object & object & object & object & object & Constructor<NewFields>, InitialMessage, { }>

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

make()

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

Inherited from

pipe()

Call Signature

static 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

Call Signature

static 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

Call Signature

static 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

Call Signature

static 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

Call Signature

static 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

Call Signature

static 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

Call Signature

static 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

Call Signature

static 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

Call Signature

static 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

Call Signature

static 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

Call Signature

static 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

Call Signature

static 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

Call Signature

static 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

Call Signature

static 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

Call Signature

static 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

Call Signature

static 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

Call Signature

static 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

Call Signature

static 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

Call Signature

static 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

Call Signature

static 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

Call Signature

static 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

Call Signature

static 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

transformOrFail()

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

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, object & object & NewFields, Encoded<object & object>, R2 | R3 | Context<NewFields[keyof NewFields]>, object & object & object & object & object & object & Constructor<NewFields>, InitialMessage, { }>

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<{ _tag: tag<“InitialMessage”> } & { clientId: typeof String$; debugInstanceId: typeof String$; devtoolsEnabled: typeof Boolean$; storageOptions: Struct<{ directory: …; type: … }>; storeId: typeof String$; syncPayload: UndefinedOr<Schema<(…), (…), (…)>> } & NewFields>[K] }, ParseIssue, R2>

encode

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

annotations?

ClassAnnotations<Transformed, { [K in string | number | symbol]: Type<{ _tag: tag<“InitialMessage”> } & { clientId: typeof String$; debugInstanceId: typeof String$; devtoolsEnabled: typeof Boolean$; storageOptions: Struct<{ directory: optional<(…)>; type: Literal<(…)> }>; storeId: typeof String$; syncPayload: UndefinedOr<Schema<JsonValue, JsonValue, never>> } & NewFields>[K] }>

Returns

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

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

transformOrFailFrom()

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

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, object & object & NewFields, Encoded<object & object>, R2 | R3 | Context<NewFields[keyof NewFields]>, object & object & object & object & object & object & Constructor<NewFields>, InitialMessage, { }>

Type Parameters

NewFields

NewFields extends Fields

R2

R2

R3

R3

Parameters

fields

NewFields

options

decode

(input, options, ast) => Effect<{ [K in string | number | symbol]: ({ _tag: “InitialMessage”; clientId: string; debugInstanceId: string; devtoolsEnabled: boolean; storageOptions: { directory?: string; type: “opfs” }; storeId: string; syncPayload: undefined | JsonValue } & {} & { 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<object & object>, ParseIssue, R3>

annotations?

Returns

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

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