Type Alias _listen

Type declaration

• • <
        R extends Record<string, any> = Record<string, any>,
        const G extends string = string,
    >(
        this: SanityClient | ObservableSanityClient,
        query: G,
        params?: ClientParams<G, ListenParams> | QueryWithoutParams,
    ): 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>
    • const G extends string = string

    Parameters

    • this: SanityClient | ObservableSanityClient
    • query: G

      GROQ-filter to listen to changes for
    • Optionalparams: ClientParams<G, ListenParams> | QueryWithoutParams

      Optional query parameters

    Returns Observable<MutationEvent<R>>
  • <
        R extends Record<string, any> = Record<string, any>,
        Opts extends
            ListenOptions | ResumableListenOptions =
            | ListenOptions
            | ResumableListenOptions,
        const G extends string = string,
    >(
        this: SanityClient | ObservableSanityClient,
        query: G,
        params?: QueryWithoutParams | ClientParams<G, 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 | ResumableListenOptions = ListenOptions | ResumableListenOptions
    • const G extends string = string

    Parameters

    • this: SanityClient | ObservableSanityClient
    • query: G

      GROQ-filter to listen to changes for
    • Optionalparams: QueryWithoutParams | ClientParams<G, ListenParams>

      Optional query parameters
    • Optionaloptions: Opts

      Optional listener options

    Returns Observable<ListenEventFromOptions<R, Opts>>