DefineEventOptions
DefineEventOptions<
TTo,TDerived> =object
Defined in: packages/@livestore/common/dist/schema/EventDef.d.ts:61
Type Parameters
Section titled “Type Parameters”TTo
TDerived
Section titled “TDerived”TDerived extends boolean = false
Properties
Section titled “Properties”clientOnly?
Section titled “clientOnly?”
optionalclientOnly:boolean
Defined in: packages/@livestore/common/dist/schema/EventDef.d.ts:76
When set to true, the event won’t be synced over the network
derived?
Section titled “derived?”
optionalderived:TDerived
Defined in: packages/@livestore/common/dist/schema/EventDef.d.ts:77
facts()?
Section titled “facts()?”
optionalfacts: (args,currentFacts) =>object
Defined in: packages/@livestore/common/dist/schema/EventDef.d.ts:63
Warning: This feature is not fully implemented yet
Parameters
Section titled “Parameters”TTo
currentFacts
Section titled “currentFacts”Returns
Section titled “Returns”modify?
Section titled “modify?”
optionalmodify:object
modify.set?
Section titled “modify.set?”
optionalset:Iterable<EventDefFactInput>
modify.unset?
Section titled “modify.unset?”
optionalunset:Iterable<EventDefFactInput>
require?
Section titled “require?”
optionalrequire:Iterable<EventDefFactInput>
Two purposes: constrain history and constrain compaction