Type Alias _listen

Type declaration

• • <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

    • this: SanityClient | ObservableSanityClient
    • query: string

      GROQ-filter to listen to changes for
    • Optionalparams: ListenParams

      Optional query parameters

    Returns Observable<MutationEvent<R>>
  • <
        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

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

    Parameters

    • this: SanityClient | ObservableSanityClient
    • query: string

      GROQ-filter to listen to changes for
    • Optionalparams: ListenParams

      Optional query parameters
    • Optionaloptions: Opts

      Optional listener options

    Returns Observable<ListenEventFromOptions<R, Opts>>