Sanity Library Reference Docs
    Preparing search index...
    Index

    Constructors

    Methods

    Constructors

    Methods

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

      Parameters

      • Optional__namedParameters: { includeDrafts?: boolean; tag?: string; waitFor?: "function" }
        • OptionalincludeDrafts?: boolean
        • Optionaltag?: string

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

          undefined

        • OptionalwaitFor?: "function"

          Delays events until after a Sanity Function has processed them and called the callback endpoint. When omitted, events are delivered immediately.

      Returns Observable<LiveEvent>