EncodedWithMeta
Defined in: packages/@livestore/common/dist/schema/LiveStoreEvent/client.d.ts:241
Internal event representation with metadata for sync processing. Includes changeset data and materializer hashes for conflict detection and rebasing.
Note: This class is exported for internal use. The preferred access is via LiveStoreEvent.Client.EncodedWithMeta.
Extends
Section titled “Extends”EncodedWithMeta_base
Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new EncodedWithMeta(
props,options?):EncodedWithMeta
Defined in: .pnpm-home/store/v11/links/@/effect/3.21.0/5f824b960b722ac9cc27ad83fe3b2945d775b034a0e1eb327a0ff67a4a7c6da7/node_modules/effect/dist/dts/Schema.d.ts:4266
Parameters
Section titled “Parameters”any
clientId
Section titled “clientId”string
{ materializerHashLeader: Option<number>; materializerHashSession: Option<number>; sessionChangeset: { _tag: "sessionChangeset"; data: Uint8Array<ArrayBuffer>; debug?: any; } | { _tag: "no-op"; } | { _tag: "unset"; }; syncMetadata: Option<JsonValue>; }
meta.materializerHashLeader
Section titled “meta.materializerHashLeader”Option<number>
meta.materializerHashSession
Section titled “meta.materializerHashSession”Option<number>
meta.sessionChangeset
Section titled “meta.sessionChangeset”{ _tag: "sessionChangeset"; data: Uint8Array<ArrayBuffer>; debug?: any; } | { _tag: "no-op"; } | { _tag: "unset"; }
meta.syncMetadata
Section titled “meta.syncMetadata”Option<JsonValue>
string
parentSeqNum
Section titled “parentSeqNum”{ client: number & Brand<"ClientEventSequenceNumber">; global: number & Brand<"GlobalEventSequenceNumber">; rebaseGeneration: number; }
parentSeqNum.client
Section titled “parentSeqNum.client”number & Brand<"ClientEventSequenceNumber">
parentSeqNum.global
Section titled “parentSeqNum.global”number & Brand<"GlobalEventSequenceNumber">
parentSeqNum.rebaseGeneration
Section titled “parentSeqNum.rebaseGeneration”number
seqNum
Section titled “seqNum”{ client: number & Brand<"ClientEventSequenceNumber">; global: number & Brand<"GlobalEventSequenceNumber">; rebaseGeneration: number; }
seqNum.client
Section titled “seqNum.client”number & Brand<"ClientEventSequenceNumber">
seqNum.global
Section titled “seqNum.global”number & Brand<"GlobalEventSequenceNumber">
seqNum.rebaseGeneration
Section titled “seqNum.rebaseGeneration”number
sessionId
Section titled “sessionId”string
options?
Section titled “options?”MakeOptions
Returns
Section titled “Returns”EncodedWithMeta
Inherited from
Section titled “Inherited from”EncodedWithMeta_base.constructor
Properties
Section titled “Properties”
readonlyargs:any
Defined in: packages/@livestore/common/dist/schema/LiveStoreEvent/client.d.ts:79
Inherited from
Section titled “Inherited from”EncodedWithMeta_base.args
clientId
Section titled “clientId”
readonlyclientId:string
Defined in: packages/@livestore/common/dist/schema/LiveStoreEvent/client.d.ts:94
Inherited from
Section titled “Inherited from”EncodedWithMeta_base.clientId
readonlymeta:object
Defined in: packages/@livestore/common/dist/schema/LiveStoreEvent/client.d.ts:96
materializerHashLeader
Section titled “materializerHashLeader”materializerHashLeader:
Option<number>
materializerHashSession
Section titled “materializerHashSession”materializerHashSession:
Option<number>
sessionChangeset
Section titled “sessionChangeset”sessionChangeset: {
_tag:"sessionChangeset";data:Uint8Array<ArrayBuffer>;debug?:any; } | {_tag:"no-op"; } | {_tag:"unset"; }
syncMetadata
Section titled “syncMetadata”syncMetadata:
Option<JsonValue>
Inherited from
Section titled “Inherited from”EncodedWithMeta_base.meta
readonlyname:string
Defined in: packages/@livestore/common/dist/schema/LiveStoreEvent/client.d.ts:78
Inherited from
Section titled “Inherited from”EncodedWithMeta_base.name
parentSeqNum
Section titled “parentSeqNum”
readonlyparentSeqNum:object
Defined in: packages/@livestore/common/dist/schema/LiveStoreEvent/client.d.ts:87
client
Section titled “client”
readonlyclient:number&Brand<"ClientEventSequenceNumber">
global
Section titled “global”
readonlyglobal:number&Brand<"GlobalEventSequenceNumber">
rebaseGeneration
Section titled “rebaseGeneration”
readonlyrebaseGeneration:number
Inherited from
Section titled “Inherited from”EncodedWithMeta_base.parentSeqNum
rebase()
Section titled “rebase()”rebase: (
__namedParameters) =>EncodedWithMeta
Defined in: packages/@livestore/common/dist/schema/LiveStoreEvent/client.d.ts:260
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
Syntax: e2.2 → e2.1 ^ ^ ^ ^ | | | +- client parent number | | +--- global parent number | +— client number +---- global number Client num is omitted for global events
Parameters
Section titled “Parameters”__namedParameters
Section titled “__namedParameters”isClient
Section titled “isClient”boolean
parentSeqNum
Section titled “parentSeqNum”rebaseGeneration
Section titled “rebaseGeneration”number
Returns
Section titled “Returns”EncodedWithMeta
seqNum
Section titled “seqNum”
readonlyseqNum:object
Defined in: packages/@livestore/common/dist/schema/LiveStoreEvent/client.d.ts:80
client
Section titled “client”
readonlyclient:number&Brand<"ClientEventSequenceNumber">
global
Section titled “global”
readonlyglobal:number&Brand<"GlobalEventSequenceNumber">
rebaseGeneration
Section titled “rebaseGeneration”
readonlyrebaseGeneration:number
Inherited from
Section titled “Inherited from”EncodedWithMeta_base.seqNum
sessionId
Section titled “sessionId”
readonlysessionId:string
Defined in: packages/@livestore/common/dist/schema/LiveStoreEvent/client.d.ts:95
Inherited from
Section titled “Inherited from”EncodedWithMeta_base.sessionId
toGlobal()
Section titled “toGlobal()”toGlobal: () =>
object
Defined in: packages/@livestore/common/dist/schema/LiveStoreEvent/client.d.ts:270
Returns
Section titled “Returns”object
readonlyargs:any
clientId
Section titled “clientId”
readonlyclientId:string
readonlyname:string
parentSeqNum
Section titled “parentSeqNum”
readonlyparentSeqNum:number&Brand<"GlobalEventSequenceNumber">
seqNum
Section titled “seqNum”
readonlyseqNum:number&Brand<"GlobalEventSequenceNumber">
sessionId
Section titled “sessionId”
readonlysessionId:string
toJSON()
Section titled “toJSON()”toJSON: () =>
any
Defined in: packages/@livestore/common/dist/schema/LiveStoreEvent/client.d.ts:242
Returns
Section titled “Returns”any
fromGlobal()
Section titled “fromGlobal()”
staticfromGlobal: (event,meta) =>EncodedWithMeta
Defined in: packages/@livestore/common/dist/schema/LiveStoreEvent/client.d.ts:265
Parameters
Section titled “Parameters”any
clientId
Section titled “clientId”string
string
parentSeqNum
Section titled “parentSeqNum”number & Brand<"GlobalEventSequenceNumber">
seqNum
Section titled “seqNum”number & Brand<"GlobalEventSequenceNumber">
sessionId
Section titled “sessionId”string
materializerHashLeader
Section titled “materializerHashLeader”Option<number>
materializerHashSession
Section titled “materializerHashSession”Option<number>
syncMetadata
Section titled “syncMetadata”Option<JsonValue>
Returns
Section titled “Returns”EncodedWithMeta