Sanity Library Reference Docs
    Preparing search index...

    Function _listen

    • _listen<R extends Record<string, any> = Record<string, any>>(
          this: SanityClient | ObservableSanityClient,
          query: string,
          params?: ListenParams,
      ): Observable<MutationEvent<R>>

      Set up a listener that will be notified when mutations occur on documents matching the provided query/filter.

      Type Parameters

      • R extends Record<string, any> = Record<string, any>

      Parameters

      Returns Observable<MutationEvent<R>>

    • _listen<
          R extends Record<string, any> = Record<string, any>,
          Opts extends ListenOptions = ListenOptions,
      >(
          this: SanityClient | ObservableSanityClient,
          query: string,
          params?: ListenParams,
          options?: Opts,
      ): Observable<ListenEventFromOptions<R, Opts>>

      Set up a listener that will be notified when mutations occur on documents matching the provided query/filter.

      Type Parameters

      Parameters

      Returns Observable<ListenEventFromOptions<R, Opts>>

    Settings

    Member Visibility