Sanity Library Reference Docs
    Preparing search index...

    Type Alias WelcomeBackEvent

    Emitted when the listener reconnects and successfully resumes from its previous position.

    Even if the listener is created with enableResume: true, resume support may not be available. In that case, a reconnect will emit welcome instead of welcomeback.

    If resumability is unavailable, even listeners created with enableResume: true may still emit welcome when reconnected. Subscribers should therefore treat welcome after a reconnect the same way they would otherwise treat a reset event.

    type WelcomeBackEvent = {
        listenerName: string;
        type: "welcomeback";
    }
    Index

    Properties

    Properties

    listenerName: string
    type: "welcomeback"