EncodedWithMeta

Defined in: packages/@livestore/common/dist/schema/LiveStoreEvent.d.ts:261

Equivalent to AnyEncoded but with a meta field and some convenience methods

Extends

EncodedWithMeta_base

Constructors

Constructor

new EncodedWithMeta(props, options?): EncodedWithMeta

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

Parameters

props

args

any

clientId

string

meta?

{ materializerHashLeader: Option<number>; materializerHashSession: Option<number>; sessionChangeset: { _tag: "sessionChangeset"; data: Uint8Array<ArrayBufferLike>; debug?: any; } | { _tag: "no-op"; } | { _tag: "unset"; }; syncMetadata: Option<JsonValue>; }

meta.materializerHashLeader

Option<number>

meta.materializerHashSession

Option<number>

meta.sessionChangeset

{ _tag: "sessionChangeset"; data: Uint8Array<ArrayBufferLike>; debug?: any; } | { _tag: "no-op"; } | { _tag: "unset"; }

meta.syncMetadata

Option<JsonValue>

name

string

parentSeqNum

{ client: any; global: any; }

parentSeqNum.client

any

parentSeqNum.global

any

seqNum

{ client: any; global: any; }

seqNum.client

any

seqNum.global

any

sessionId

string

options?

MakeOptions

Returns

EncodedWithMeta

Inherited from

EncodedWithMeta_base.constructor

Properties

args

readonly args: any

Defined in: packages/@livestore/common/dist/schema/LiveStoreEvent.d.ts:118

Inherited from

EncodedWithMeta_base.args

clientId

readonly clientId: string

Defined in: packages/@livestore/common/dist/schema/LiveStoreEvent.d.ts:127

Inherited from

EncodedWithMeta_base.clientId

name

readonly name: string

Defined in: packages/@livestore/common/dist/schema/LiveStoreEvent.d.ts:117

Inherited from

EncodedWithMeta_base.name

parentSeqNum

readonly parentSeqNum: object

Defined in: packages/@livestore/common/dist/schema/LiveStoreEvent.d.ts:123

client

readonly client: any

global

readonly global: any

Inherited from

EncodedWithMeta_base.parentSeqNum

rebase()

rebase: (parentSeqNum, isClient) => EncodedWithMeta

Defined in: packages/@livestore/common/dist/schema/LiveStoreEvent.d.ts:280

Example: (global event) For event e2 → e1 which should be rebased on event e3 → e2 the resulting event num will be e4 → e3

Example: (client event) For event e2+1 → e2 which should be rebased on event e3 → e2 the resulting event num will be e3+1 → e3

Parameters

parentSeqNum

EventSequenceNumber

isClient

boolean

Returns

EncodedWithMeta

seqNum

readonly seqNum: object

Defined in: packages/@livestore/common/dist/schema/LiveStoreEvent.d.ts:119

client

readonly client: any

global

readonly global: any

Inherited from

EncodedWithMeta_base.seqNum

sessionId

readonly sessionId: string

Defined in: packages/@livestore/common/dist/schema/LiveStoreEvent.d.ts:128

Inherited from

EncodedWithMeta_base.sessionId

toGlobal()

toGlobal: () => object

Defined in: packages/@livestore/common/dist/schema/LiveStoreEvent.d.ts:286

Returns

object

args

readonly args: any

clientId

readonly clientId: string

name

readonly name: string

parentSeqNum

readonly parentSeqNum: any

seqNum

readonly seqNum: any

sessionId

readonly sessionId: string

toJSON()

toJSON: () => any

Defined in: packages/@livestore/common/dist/schema/LiveStoreEvent.d.ts:262

Returns

any

[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<EncodedWithMeta>

_I

readonly _I: Invariant<{ args: any; clientId: string; meta?: { materializerHashLeader: { _tag: "None"; } | { _tag: "Some"; value: number; }; materializerHashSession: { _tag: "None"; } | { _tag: "Some"; value: number; }; sessionChangeset: { _tag: "sessionChangeset"; data: readonly number[]; debug?: any; } | { _tag: "no-op"; } | { _tag: "unset"; }; syncMetadata: { _tag: "None"; } | { _tag: "Some"; value: JsonValue; }; }; name: string; parentSeqNum: { client: number; global: number; }; seqNum: { client: number; global: number; }; sessionId: string; }>

_R

readonly _R: Covariant<never>

Inherited from

EncodedWithMeta_base.[TypeId]

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

EncodedWithMeta_base.ast

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

EncodedWithMeta_base.Context

Encoded

readonly static Encoded: object

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

args

args: any

clientId

clientId: string

meta?

optional meta: object

meta.materializerHashLeader

materializerHashLeader: { _tag: "None"; } | { _tag: "Some"; value: number; }

meta.materializerHashSession

materializerHashSession: { _tag: "None"; } | { _tag: "Some"; value: number; }

meta.sessionChangeset

sessionChangeset: { _tag: "sessionChangeset"; data: readonly number[]; debug?: any; } | { _tag: "no-op"; } | { _tag: "unset"; }

meta.syncMetadata

syncMetadata: { _tag: "None"; } | { _tag: "Some"; value: JsonValue; }

name

name: string

parentSeqNum

parentSeqNum: object

parentSeqNum.client

client: number

parentSeqNum.global

global: number

seqNum

seqNum: object

seqNum.client

client: number

seqNum.global

global: number

sessionId

sessionId: string

Inherited from

EncodedWithMeta_base.Encoded

fields

readonly static fields: object

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

args

readonly args: typeof Any

clientId

readonly clientId: typeof String$

name

readonly name: typeof String$

parentSeqNum

readonly parentSeqNum: Struct<{ client: BrandSchema<any, number, never>; global: BrandSchema<any, number, never>; }>

seqNum

readonly seqNum: Struct<{ client: BrandSchema<any, number, never>; global: BrandSchema<any, number, never>; }>

sessionId

readonly sessionId: typeof String$

Inherited from

EncodedWithMeta_base.fields

fromGlobal()

static fromGlobal: (event, meta) => EncodedWithMeta

Defined in: packages/@livestore/common/dist/schema/LiveStoreEvent.d.ts:281

Parameters

event

args

any

clientId

string

name

string

parentSeqNum

any

seqNum

any

sessionId

string

Returns

EncodedWithMeta

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

EncodedWithMeta_base.identifier

Type

readonly static Type: EncodedWithMeta

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

Inherited from

EncodedWithMeta_base.Type

Methods

annotations()

static annotations(annotations): SchemaClass<EncodedWithMeta, { args: any; clientId: string; meta?: { materializerHashLeader: { _tag: "None"; } | { _tag: "Some"; value: number; }; materializerHashSession: { _tag: "None"; } | { _tag: "Some"; value: number; }; sessionChangeset: { _tag: "sessionChangeset"; data: readonly number[]; debug?: any; } | { _tag: "no-op"; } | { _tag: "unset"; }; syncMetadata: { _tag: "None"; } | { _tag: "Some"; value: JsonValue; }; }; name: string; parentSeqNum: { client: number; global: number; }; seqNum: { client: number; global: number; }; sessionId: string; }, 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<EncodedWithMeta>

Returns

SchemaClass<EncodedWithMeta, { args: any; clientId: string; meta?: { materializerHashLeader: { _tag: "None"; } | { _tag: "Some"; value: number; }; materializerHashSession: { _tag: "None"; } | { _tag: "Some"; value: number; }; sessionChangeset: { _tag: "sessionChangeset"; data: readonly number[]; debug?: any; } | { _tag: "no-op"; } | { _tag: "unset"; }; syncMetadata: { _tag: "None"; } | { _tag: "Some"; value: JsonValue; }; }; name: string; parentSeqNum: { client: number; global: number; }; seqNum: { client: number; global: number; }; sessionId: string; }, never>

Inherited from

EncodedWithMeta_base.annotations

extend()

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

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 & 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 & object & Constructor<NewFields>, EncodedWithMeta, { }>

Type Parameters

NewFields

NewFields extends Fields

Parameters

fields

NewFields | HasFields<NewFields>

annotations?

ClassAnnotations<Extended, { [K in string | number | symbol]: Type<{ args: typeof Any; clientId: typeof String$; meta: PropertySignature<”:”, { materializerHashLeader: Option<(…)>; materializerHashSession: Option<(…)>; sessionChangeset: (…) | (…) | (…); syncMetadata: Option<(…)> }, never, ”?:”, undefined | { materializerHashLeader: …; materializerHashSession: …; sessionChangeset: …; syncMetadata: … }, true, never>; name: typeof String$; parentSeqNum: Struct<{ client: BrandSchema<(…), (…), (…)>; global: BrandSchema<(…), (…), (…)> }>; seqNum: Struct<{ client: BrandSchema<(…), (…), (…)>; global: BrandSchema<(…), (…), (…)> }>; sessionId: typeof String$ } & NewFields>[K] }>

Returns

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

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

EncodedWithMeta_base.extend

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

EncodedWithMeta_base.make

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

EncodedWithMeta_base.pipe

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

EncodedWithMeta_base.pipe

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

EncodedWithMeta_base.pipe

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

EncodedWithMeta_base.pipe

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

EncodedWithMeta_base.pipe

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

EncodedWithMeta_base.pipe

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

EncodedWithMeta_base.pipe

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

EncodedWithMeta_base.pipe

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

EncodedWithMeta_base.pipe

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

EncodedWithMeta_base.pipe

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

EncodedWithMeta_base.pipe

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

EncodedWithMeta_base.pipe

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

EncodedWithMeta_base.pipe

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

EncodedWithMeta_base.pipe

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

EncodedWithMeta_base.pipe

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

EncodedWithMeta_base.pipe

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

EncodedWithMeta_base.pipe

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

EncodedWithMeta_base.pipe

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

EncodedWithMeta_base.pipe

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

EncodedWithMeta_base.pipe

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

EncodedWithMeta_base.pipe

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

EncodedWithMeta_base.pipe

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 & NewFields, Encoded<{ args: typeof Any; clientId: typeof String$; meta: PropertySignature<":", { materializerHashLeader: Option<number>; materializerHashSession: Option<number>; sessionChangeset: { _tag: "sessionChangeset"; data: Uint8Array<ArrayBufferLike>; debug?: any; } | { _tag: "no-op"; } | { _tag: "unset"; }; syncMetadata: Option<JsonValue>; }, never, "?:", undefined | { materializerHashLeader: { _tag: "None"; } | { _tag: "Some"; value: number; }; materializerHashSession: { _tag: "None"; } | { _tag: "Some"; value: number; }; sessionChangeset: { _tag: "sessionChangeset"; data: readonly …[]; debug?: any; } | { _tag: "no-op"; } | { _tag: "unset"; }; syncMetadata: { _tag: "None"; } | { _tag: "Some"; value: JsonValue; }; }, true, never>; name: typeof String$; parentSeqNum: Struct<{ client: BrandSchema<any, number, never>; global: BrandSchema<any, number, never>; }>; seqNum: Struct<{ client: BrandSchema<any, number, never>; global: BrandSchema<any, number, never>; }>; sessionId: typeof String$; }>, R2 | R3 | Context<NewFields[keyof NewFields]>, object & object & object & object & object & object & object & Constructor<NewFields>, EncodedWithMeta, { }>

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 & NewFields, Encoded<{ args: typeof Any; clientId: typeof String$; meta: PropertySignature<":", { materializerHashLeader: Option<number>; materializerHashSession: Option<number>; sessionChangeset: { _tag: "sessionChangeset"; data: Uint8Array<ArrayBufferLike>; debug?: any; } | { _tag: "no-op"; } | { _tag: "unset"; }; syncMetadata: Option<JsonValue>; }, never, "?:", undefined | { materializerHashLeader: { _tag: "None"; } | { _tag: "Some"; value: number; }; materializerHashSession: { _tag: "None"; } | { _tag: "Some"; value: number; }; sessionChangeset: { _tag: "sessionChangeset"; data: readonly …[]; debug?: any; } | { _tag: "no-op"; } | { _tag: "unset"; }; syncMetadata: { _tag: "None"; } | { _tag: "Some"; value: JsonValue; }; }, true, never>; name: typeof String$; parentSeqNum: Struct<{ client: BrandSchema<any, number, never>; global: BrandSchema<any, number, never>; }>; seqNum: Struct<{ client: BrandSchema<any, number, never>; global: BrandSchema<any, number, never>; }>; sessionId: typeof String$; }>, R2 | R3 | Context<NewFields[keyof NewFields]>, object & object & object & object & object & object & object & Constructor<NewFields>, EncodedWithMeta, { }>

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<{ args: typeof Any; clientId: typeof String$; meta: PropertySignature<”:”, { materializerHashLeader: …; materializerHashSession: …; sessionChangeset: …; syncMetadata: … }, never, ”?:”, (…) | (…), true, never>; name: typeof String$; parentSeqNum: Struct<{ client: …; global: … }>; seqNum: Struct<{ client: …; global: … }>; sessionId: typeof String$ } & 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<{ args: typeof Any; clientId: typeof String$; meta: PropertySignature<”:”, { materializerHashLeader: Option<(…)>; materializerHashSession: Option<(…)>; sessionChangeset: (…) | (…) | (…); syncMetadata: Option<(…)> }, never, ”?:”, undefined | { materializerHashLeader: …; materializerHashSession: …; sessionChangeset: …; syncMetadata: … }, true, never>; name: typeof String$; parentSeqNum: Struct<{ client: BrandSchema<(…), (…), (…)>; global: BrandSchema<(…), (…), (…)> }>; seqNum: Struct<{ client: BrandSchema<(…), (…), (…)>; global: BrandSchema<(…), (…), (…)> }>; sessionId: typeof String$ } & NewFields>[K] }>

Returns

[Transformed] extends [never] ? "Missing `Self` generic - use `class Self extends Base.transformOrFail<Self>()({ ... })`" : Class<Transformed, object & NewFields, Encoded<{ args: typeof Any; clientId: typeof String$; meta: PropertySignature<":", { materializerHashLeader: Option<number>; materializerHashSession: Option<number>; sessionChangeset: { _tag: "sessionChangeset"; data: Uint8Array<ArrayBufferLike>; debug?: any; } | { _tag: "no-op"; } | { _tag: "unset"; }; syncMetadata: Option<JsonValue>; }, never, "?:", undefined | { materializerHashLeader: { _tag: "None"; } | { _tag: "Some"; value: number; }; materializerHashSession: { _tag: "None"; } | { _tag: "Some"; value: number; }; sessionChangeset: { _tag: "sessionChangeset"; data: readonly …[]; debug?: any; } | { _tag: "no-op"; } | { _tag: "unset"; }; syncMetadata: { _tag: "None"; } | { _tag: "Some"; value: JsonValue; }; }, true, never>; name: typeof String$; parentSeqNum: Struct<{ client: BrandSchema<any, number, never>; global: BrandSchema<any, number, never>; }>; seqNum: Struct<{ client: BrandSchema<any, number, never>; global: BrandSchema<any, number, never>; }>; sessionId: typeof String$; }>, R2 | R3 | Context<NewFields[keyof NewFields]>, object & object & object & object & object & object & object & Constructor<NewFields>, EncodedWithMeta, { }>

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

EncodedWithMeta_base.transformOrFail

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 & NewFields, Encoded<{ args: typeof Any; clientId: typeof String$; meta: PropertySignature<":", { materializerHashLeader: Option<number>; materializerHashSession: Option<number>; sessionChangeset: { _tag: "sessionChangeset"; data: Uint8Array<ArrayBufferLike>; debug?: any; } | { _tag: "no-op"; } | { _tag: "unset"; }; syncMetadata: Option<JsonValue>; }, never, "?:", undefined | { materializerHashLeader: { _tag: "None"; } | { _tag: "Some"; value: number; }; materializerHashSession: { _tag: "None"; } | { _tag: "Some"; value: number; }; sessionChangeset: { _tag: "sessionChangeset"; data: readonly …[]; debug?: any; } | { _tag: "no-op"; } | { _tag: "unset"; }; syncMetadata: { _tag: "None"; } | { _tag: "Some"; value: JsonValue; }; }, true, never>; name: typeof String$; parentSeqNum: Struct<{ client: BrandSchema<any, number, never>; global: BrandSchema<any, number, never>; }>; seqNum: Struct<{ client: BrandSchema<any, number, never>; global: BrandSchema<any, number, never>; }>; sessionId: typeof String$; }>, R2 | R3 | Context<NewFields[keyof NewFields]>, object & object & object & object & object & object & object & Constructor<NewFields>, EncodedWithMeta, { }>

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 & NewFields, Encoded<{ args: typeof Any; clientId: typeof String$; meta: PropertySignature<":", { materializerHashLeader: Option<number>; materializerHashSession: Option<number>; sessionChangeset: { _tag: "sessionChangeset"; data: Uint8Array<ArrayBufferLike>; debug?: any; } | { _tag: "no-op"; } | { _tag: "unset"; }; syncMetadata: Option<JsonValue>; }, never, "?:", undefined | { materializerHashLeader: { _tag: "None"; } | { _tag: "Some"; value: number; }; materializerHashSession: { _tag: "None"; } | { _tag: "Some"; value: number; }; sessionChangeset: { _tag: "sessionChangeset"; data: readonly …[]; debug?: any; } | { _tag: "no-op"; } | { _tag: "unset"; }; syncMetadata: { _tag: "None"; } | { _tag: "Some"; value: JsonValue; }; }, true, never>; name: typeof String$; parentSeqNum: Struct<{ client: BrandSchema<any, number, never>; global: BrandSchema<any, number, never>; }>; seqNum: Struct<{ client: BrandSchema<any, number, never>; global: BrandSchema<any, number, never>; }>; sessionId: typeof String$; }>, R2 | R3 | Context<NewFields[keyof NewFields]>, object & object & object & object & object & object & object & Constructor<NewFields>, EncodedWithMeta, { }>

Type Parameters

NewFields

NewFields extends Fields

R2

R2

R3

R3

Parameters

fields

NewFields

options

decode

(input, options, ast) => Effect<{ [K in string | number | symbol]: ({ args: any; clientId: string; name: string; parentSeqNum: { client: number; global: number }; seqNum: { client: number; global: number }; sessionId: string } & { meta?: { materializerHashLeader: (…) | (…); materializerHashSession: (…) | (…); sessionChangeset: (…) | (…) | (…); syncMetadata: (…) | (…) } } & { 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<{ args: typeof Any; clientId: typeof String$; meta: PropertySignature<":", { materializerHashLeader: Option<number>; materializerHashSession: Option<number>; sessionChangeset: { _tag: "sessionChangeset"; data: Uint8Array<…>; debug?: any; } | { _tag: "no-op"; } | { _tag: "unset"; }; syncMetadata: Option<JsonValue>; }, never, "?:", undefined | { materializerHashLeader: { _tag: …; } | { _tag: …; value: …; }; materializerHashSession: { _tag: …; } | { _tag: …; value: …; }; sessionChangeset: { _tag: …; data: …; debug?: …; } | { _tag: …; } | { _tag: …; }; syncMetadata: { _tag: …; } | { _tag: …; value: …; }; }, true, never>; name: typeof String$; parentSeqNum: Struct<{ client: BrandSchema<any, number, never>; global: BrandSchema<any, number, never>; }>; seqNum: Struct<{ client: BrandSchema<any, number, never>; global: BrandSchema<any, number, never>; }>; sessionId: typeof String$; }>, ParseIssue, R3>

annotations?

Returns

[Transformed] extends [never] ? "Missing `Self` generic - use `class Self extends Base.transformOrFailFrom<Self>()({ ... })`" : Class<Transformed, object & NewFields, Encoded<{ args: typeof Any; clientId: typeof String$; meta: PropertySignature<":", { materializerHashLeader: Option<number>; materializerHashSession: Option<number>; sessionChangeset: { _tag: "sessionChangeset"; data: Uint8Array<ArrayBufferLike>; debug?: any; } | { _tag: "no-op"; } | { _tag: "unset"; }; syncMetadata: Option<JsonValue>; }, never, "?:", undefined | { materializerHashLeader: { _tag: "None"; } | { _tag: "Some"; value: number; }; materializerHashSession: { _tag: "None"; } | { _tag: "Some"; value: number; }; sessionChangeset: { _tag: "sessionChangeset"; data: readonly …[]; debug?: any; } | { _tag: "no-op"; } | { _tag: "unset"; }; syncMetadata: { _tag: "None"; } | { _tag: "Some"; value: JsonValue; }; }, true, never>; name: typeof String$; parentSeqNum: Struct<{ client: BrandSchema<any, number, never>; global: BrandSchema<any, number, never>; }>; seqNum: Struct<{ client: BrandSchema<any, number, never>; global: BrandSchema<any, number, never>; }>; sessionId: typeof String$; }>, R2 | R3 | Context<NewFields[keyof NewFields]>, object & object & object & object & object & object & object & Constructor<NewFields>, EncodedWithMeta, { }>

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

EncodedWithMeta_base.transformOrFailFrom