EventDef
EventDef<
TName,TType,TEncoded,TDerived> =object
Defined in: packages/@livestore/common/dist/schema/EventDef.d.ts:12
Type Parameters
Section titled “Type Parameters”TName extends string
TType
TEncoded
Section titled “TEncoded”TEncoded = TType
TDerived
Section titled “TDerived”TDerived extends boolean = false
EventDef(
args):object
Defined in: packages/@livestore/common/dist/schema/EventDef.d.ts:25
Helper function to construct a partial event
Parameters
Section titled “Parameters”TType
Returns
Section titled “Returns”object
args:
TType
name:
TName
Properties
Section titled “Properties”encoded()
Section titled “encoded()”encoded: (
args) =>object
Defined in: packages/@livestore/common/dist/schema/EventDef.d.ts:30
Helper function to construct a partial encoded event
Parameters
Section titled “Parameters”TEncoded
Returns
Section titled “Returns”object
args:
TEncoded
name:
TName
readonlyEvent:object
Defined in: packages/@livestore/common/dist/schema/EventDef.d.ts:34
args:
TType
name:
TName
name:
TName
Defined in: packages/@livestore/common/dist/schema/EventDef.d.ts:13
options
Section titled “options”options:
object
Defined in: packages/@livestore/common/dist/schema/EventDef.d.ts:15
clientOnly
Section titled “clientOnly”clientOnly:
boolean
When set to true, the mutation won’t be synced across clients but
derived
Section titled “derived”derived:
TDerived
facts:
FactsCallback<TType> |undefined
Warning: This feature is not fully implemented yet
schema
Section titled “schema”schema:
Schema<TType,TEncoded>
Defined in: packages/@livestore/common/dist/schema/EventDef.d.ts:14