defineEvent

const defineEvent: <TName, TType, TEncoded, TDerived>(args) => EventDef<TName, TType, TEncoded, TDerived>

Defined in: packages/@livestore/common/dist/schema/EventDef/define.d.ts:80

Creates an event definition with full control over all options.

This is the low-level function for creating events. For most cases, prefer using synced() or clientOnly() which provide simpler APIs.

Type Parameters

TName

TName extends string

TType

TType

TEncoded

TEncoded = TType

TDerived

TDerived extends boolean = false

Parameters

args

object & DefineEventOptions<TType, TDerived>

Returns

EventDef<TName, TType, TEncoded, TDerived>

Example

const customEvent = defineEvent({
  name: 'v1.CustomEvent',
  schema: Schema.Struct({ data: Schema.String }),
  clientOnly: false,
  derived: false,
})