Sanity Library Reference Docs
    Preparing search index...

    Type Alias WelcomeEvent

    Emitted when the listener connection has been successfully established and is ready to receive events.

    If the listener was created with enableResume: true and resume support is available, the welcome event will only be emitted on the initial connection. On subsequent reconnects, a welcomeback event will be emitted instead, followed by any events that were missed while the connection was disconnected.

    type WelcomeEvent = {
        listenerName: string;
        type: "welcome";
    }
    Index

    Properties

    Properties

    listenerName: string
    type: "welcome"