Skip to content
Work in progress. These docs describe Spawnite at launch, and some parts are still being built.

EventOptions

EventOptions<Record, Delivery, Scope> = object & EventEntitiesOptions<Record>

What an event declares beyond its record: where it goes, what it is about, and the fields that hold an entity, which a record that holds one must name.

Name Type Description
delivery? Delivery Where it goes; reliable when left out.
elements? { [Field in keyof Record]?: () => unknown } For a list the record holds, such as hits, what one of its records is: a page reads a streamed list by it, so a vector in a record comes back a vector where the empty default has none to go by.
scope? Scope On one entity, or about the world; an entity when left out.
Type Parameter Default type
Record -
Delivery extends EventDelivery EventDelivery
Scope extends EventScope EventScope