EncodedWithMeta
Defined in: packages/@livestore/common/dist/schema/LiveStoreEvent/client.d.ts:112
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(…
args):EncodedWithMeta
Defined in: node_modules/.pnpm/effect@4.0.0-beta.99/node_modules/effect/dist/Schema.d.ts:8372
Parameters
Section titled “Parameters”…[object, 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”
readonlymaterializerHashLeader:Option<number>
materializerHashSession
Section titled “materializerHashSession”
readonlymaterializerHashSession:Option<number>
sessionChangeset
Section titled “sessionChangeset”
readonlysessionChangeset: {data:Uint8Array<ArrayBuffer>;debug?:any; } |ReadonlySide<{ },"Type"> |ReadonlySide<{ },"Type">
syncMetadata
Section titled “syncMetadata”
readonlysyncMetadata:Option<Json>
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:ReadonlySide<{client:brand<Int,"ClientEventSequenceNumber">;global:brand<Int,"GlobalEventSequenceNumber">;rebaseGeneration:Int; },"Type">
Defined in: packages/@livestore/common/dist/schema/LiveStoreEvent/client.d.ts:87
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:131
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”isClientOnly
Section titled “isClientOnly”boolean
parentSeqNum
Section titled “parentSeqNum”rebaseGeneration
Section titled “rebaseGeneration”number
Returns
Section titled “Returns”EncodedWithMeta
seqNum
Section titled “seqNum”
readonlyseqNum:ReadonlySide<{client:brand<Int,"ClientEventSequenceNumber">;global:brand<Int,"GlobalEventSequenceNumber">;rebaseGeneration:Int; },"Type">
Defined in: packages/@livestore/common/dist/schema/LiveStoreEvent/client.d.ts:80
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: () =>
Encoded
Defined in: packages/@livestore/common/dist/schema/LiveStoreEvent/client.d.ts:141
Returns
Section titled “Returns”toJSON()
Section titled “toJSON()”toJSON: () =>
any
Defined in: packages/@livestore/common/dist/schema/LiveStoreEvent/client.d.ts:113
Returns
Section titled “Returns”any
fromGlobal()
Section titled “fromGlobal()”
staticfromGlobal: (event,meta) =>EncodedWithMeta
Defined in: packages/@livestore/common/dist/schema/LiveStoreEvent/client.d.ts:136
Parameters
Section titled “Parameters”materializerHashLeader
Section titled “materializerHashLeader”Option<number>
materializerHashSession
Section titled “materializerHashSession”Option<number>
syncMetadata
Section titled “syncMetadata”Option<Json>
Returns
Section titled “Returns”EncodedWithMeta