Sanity Library Reference Docs
    Preparing search index...

    Interface LiveClient

    interface LiveClient {
        events(
            __namedParameters?: { includeDrafts?: boolean; tag?: string },
        ): Observable<LiveEvent>;
    }
    Index

    Methods

    Methods

    • Requires apiVersion to be 2021-03-25 or later.

      Parameters

      • __namedParameters: { includeDrafts?: boolean; tag?: string } = {}
        • OptionalincludeDrafts?: boolean
        • Optionaltag?: string

          Optional request tag for the listener. Use to identify the request in logs.

          undefined

      Returns Observable<LiveEvent>