EncodedWithMeta

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

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

Extends

• EncodedWithMeta_base

Constructors

new EncodedWithMeta()

new EncodedWithMeta(props, options?): EncodedWithMeta

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

Parameters

props

args

any

clientId

string

id

{ client: any; global: any; }

id.client

any

id.global

any

meta?

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

meta.sessionChangeset

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

meta.syncMetadata

Option<JsonValue>

name

string

parentId

{ client: any; global: any; }

parentId.client

any

parentId.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:116

Inherited from

EncodedWithMeta_base.args

---

clientId

readonly clientId: string

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

Inherited from

EncodedWithMeta_base.clientId

---

id

readonly id: object

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

client

readonly client: any

global

readonly global: any

Inherited from

EncodedWithMeta_base.id

---

meta

readonly meta: object

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

sessionChangeset

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

syncMetadata

syncMetadata: Option<JsonValue>

Inherited from

EncodedWithMeta_base.meta

---

name

readonly name: string

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

Inherited from

EncodedWithMeta_base.name

---

parentId

readonly parentId: object

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

client

readonly client: any

global

readonly global: any

Inherited from

EncodedWithMeta_base.parentId

---

rebase()

rebase: (parentId, isClient) => EncodedWithMeta

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

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

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

Syntax: e2+2 → e2+1 ^ ^ ^ ^ | | | +- client parent id | | +--- global parent id | +— client id +---- global id Client id is ommitted for global events

Parameters

parentId

EventId

isClient

boolean

Returns

EncodedWithMeta

---

sessionId

readonly sessionId: string

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

Inherited from

EncodedWithMeta_base.sessionId

---

toGlobal()

toGlobal: () => object

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

Returns

object

args

readonly args: any

clientId

readonly clientId: string

id

readonly id: any

name

readonly name: string

parentId

readonly parentId: any

sessionId

readonly sessionId: string

---

toJSON()

toJSON: () => any

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

Returns

any

---

[TypeId]

readonly static [TypeId]: object

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

_A

readonly _A: Invariant<EncodedWithMeta>

_I

readonly _I: Invariant<{ args: any; clientId: string; id: { client: number; global: number; }; meta: { sessionChangeset: { _tag: "sessionChangeset"; data: readonly number[]; debug: any; } | { _tag: "no-op"; } | { _tag: "unset"; }; syncMetadata: { _tag: "None"; } | { _tag: "Some"; value: JsonValue; }; }; name: string; parentId: { 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.14.8/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.14.8/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.14.8/node_modules/effect/dist/dts/Schema.d.ts:62

args

args: any

clientId

clientId: string

id

id: object

id.client

client: number

id.global

global: number

meta?

optional meta: object

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

parentId

parentId: object

parentId.client

client: number

parentId.global

global: number

sessionId

sessionId: string

Inherited from

EncodedWithMeta_base.Encoded

---

fields

readonly static fields: object

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

args

readonly args: typeof Any

clientId

readonly clientId: typeof String$

id

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

meta

readonly meta: PropertySignature<":", { sessionChangeset: { _tag: "sessionChangeset"; data: Uint8Array<ArrayBufferLike>; debug: any; } | { _tag: "no-op"; } | { _tag: "unset"; }; syncMetadata: Option<JsonValue>; }, never, "?:", undefined | { sessionChangeset: { _tag: "sessionChangeset"; data: readonly number[]; debug: any; } | { _tag: "no-op"; } | { _tag: "unset"; }; syncMetadata: { _tag: "None"; } | { _tag: "Some"; value: JsonValue; }; }, true, never>

name

readonly name: typeof String$

parentId

readonly parentId: 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, syncMetadata) => EncodedWithMeta

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

Parameters

event

args

any

clientId

string

id

any

name

string

parentId

any

sessionId

string

syncMetadata

Option<JsonValue>

Returns

EncodedWithMeta

---

identifier

readonly static identifier: string

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

Inherited from

EncodedWithMeta_base.identifier

---

Type

readonly static Type: EncodedWithMeta

Defined in: node_modules/.pnpm/effect@3.14.8/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; id: { client: number; global: number; }; meta: { sessionChangeset: { _tag: "sessionChangeset"; data: readonly number[]; debug: any; } | { _tag: "no-op"; } | { _tag: "unset"; }; syncMetadata: { _tag: "None"; } | { _tag: "Some"; value: JsonValue; }; }; name: string; parentId: { client: number; global: number; }; sessionId: string; }, never>

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

Returns

SchemaClass<EncodedWithMeta, { args: any; clientId: string; id: { client: number; global: number; }; meta: { sessionChangeset: { _tag: "sessionChangeset"; data: readonly number[]; debug: any; } | { _tag: "no-op"; } | { _tag: "unset"; }; syncMetadata: { _tag: "None"; } | { _tag: "Some"; value: JsonValue; }; }; name: string; parentId: { 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.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<{ args: typeof Any; clientId: typeof String$; id: Struct<{ client: BrandSchema<(…), (…), (…)>; global: BrandSchema<(…), (…), (…)> }>; meta: PropertySignature<”:”, { sessionChangeset: (…) | (…) | (…); syncMetadata: Option<(…)> }, never, ”?:”, undefined | { sessionChangeset: …; syncMetadata: … }, true, never>; name: typeof String$; parentId: 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<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

EncodedWithMeta_base.make

---

pipe()

Call Signature

static 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

EncodedWithMeta_base.pipe

Call Signature

static 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

EncodedWithMeta_base.pipe

Call Signature

static 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

EncodedWithMeta_base.pipe

Call Signature

static 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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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$; id: Struct<{ client: BrandSchema<any, number, never>; global: BrandSchema<any, number, never>; }>; meta: PropertySignature<":", { sessionChangeset: { _tag: "sessionChangeset"; data: Uint8Array<ArrayBufferLike>; debug: any; } | { _tag: "no-op"; } | { _tag: "unset"; }; syncMetadata: Option<JsonValue>; }, never, "?:", undefined | { sessionChangeset: { _tag: "sessionChangeset"; data: readonly …[]; debug: any; } | { _tag: "no-op"; } | { _tag: "unset"; }; syncMetadata: { _tag: "None"; } | { _tag: "Some"; value: JsonValue; }; }, true, never>; name: typeof String$; parentId: 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.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<{ args: typeof Any; clientId: typeof String$; id: Struct<{ client: …; global: … }>; meta: PropertySignature<”:”, { sessionChangeset: …; syncMetadata: … }, never, ”?:”, (…) | (…), true, never>; name: typeof String$; parentId: 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$; id: Struct<{ client: BrandSchema<(…), (…), (…)>; global: BrandSchema<(…), (…), (…)> }>; meta: PropertySignature<”:”, { sessionChangeset: (…) | (…) | (…); syncMetadata: Option<(…)> }, never, ”?:”, undefined | { sessionChangeset: …; syncMetadata: … }, true, never>; name: typeof String$; parentId: 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$; id: Struct<{ client: BrandSchema<any, number, never>; global: BrandSchema<any, number, never>; }>; meta: PropertySignature<":", { sessionChangeset: { _tag: "sessionChangeset"; data: Uint8Array<ArrayBufferLike>; debug: any; } | { _tag: "no-op"; } | { _tag: "unset"; }; syncMetadata: Option<JsonValue>; }, never, "?:", undefined | { sessionChangeset: { _tag: "sessionChangeset"; data: readonly …[]; debug: any; } | { _tag: "no-op"; } | { _tag: "unset"; }; syncMetadata: { _tag: "None"; } | { _tag: "Some"; value: JsonValue; }; }, true, never>; name: typeof String$; parentId: 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$; id: Struct<{ client: BrandSchema<any, number, never>; global: BrandSchema<any, number, never>; }>; meta: PropertySignature<":", { sessionChangeset: { _tag: "sessionChangeset"; data: Uint8Array<ArrayBufferLike>; debug: any; } | { _tag: "no-op"; } | { _tag: "unset"; }; syncMetadata: Option<JsonValue>; }, never, "?:", undefined | { sessionChangeset: { _tag: "sessionChangeset"; data: readonly …[]; debug: any; } | { _tag: "no-op"; } | { _tag: "unset"; }; syncMetadata: { _tag: "None"; } | { _tag: "Some"; value: JsonValue; }; }, true, never>; name: typeof String$; parentId: 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.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]: ({ args: any; clientId: string; id: { client: number; global: number }; name: string; parentId: { client: number; global: number }; sessionId: string } & { meta?: { 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$; id: Struct<{ client: BrandSchema<any, number, never>; global: BrandSchema<any, number, never>; }>; meta: PropertySignature<":", { sessionChangeset: { _tag: "sessionChangeset"; data: Uint8Array<…>; debug: any; } | { _tag: "no-op"; } | { _tag: "unset"; }; syncMetadata: Option<JsonValue>; }, never, "?:", undefined | { sessionChangeset: { _tag: …; data: …; debug: …; } | { _tag: …; } | { _tag: …; }; syncMetadata: { _tag: …; } | { _tag: …; value: …; }; }, true, never>; name: typeof String$; parentId: Struct<{ client: BrandSchema<any, number, never>; global: BrandSchema<any, number, never>; }>; sessionId: typeof String$; }>, ParseIssue, R3>

annotations?

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

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$; id: Struct<{ client: BrandSchema<any, number, never>; global: BrandSchema<any, number, never>; }>; meta: PropertySignature<":", { sessionChangeset: { _tag: "sessionChangeset"; data: Uint8Array<ArrayBufferLike>; debug: any; } | { _tag: "no-op"; } | { _tag: "unset"; }; syncMetadata: Option<JsonValue>; }, never, "?:", undefined | { sessionChangeset: { _tag: "sessionChangeset"; data: readonly …[]; debug: any; } | { _tag: "no-op"; } | { _tag: "unset"; }; syncMetadata: { _tag: "None"; } | { _tag: "Some"; value: JsonValue; }; }, true, never>; name: typeof String$; parentId: 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