Type Alias SanityLiveOnWelcome

SanityLiveOnWelcome: (
event: Extract<LiveEvent, { type: "welcome" }>,
context: SanityLiveContext,
) => void | Promise<void>

Handles the Live Content API welcome event.

This event fires when the EventSource connection is established. The default event handler logs a message that adapts the message based on wether includeDrafts is set, and if waitFor="function" is set. Set <SanityLive onWelcome={false} /> to disable the default behavior.