MCPcopy Create free account
hub / github.com/TanStack/query / subscribe

Method subscribe

packages/query-core/src/subscribable.ts:31–40  ·  view source on GitHub ↗

* Registers a listener to be called on every update this object notifies about. Returns a function * that removes the listener again — call it to stop listening. The base class never drops a listener * on its own, though some subclasses clear all of theirs in `destroy()`. * @param listener

(listener: TListener)

Source from the content-addressed store, hash-verified

29 * ```
30 */
31 subscribe(listener: TListener): () => void {
32 this.listeners.add(listener)
33
34 this.onSubscribe()
35
36 return () => {
37 this.listeners.delete(listener)
38 this.onUnsubscribe()
39 }
40 }
41
42 /**
43 * Returns `true` while at least one listener is registered, `false` once they have all unsubscribed.

Callers 15

useBaseQueryFunction · 0.45
useMutationFunction · 0.45
useMutationStateFunction · 0.45
useQueriesFunction · 0.45
useIsFetchingFunction · 0.45
setupDevtoolsFunction · 0.45
DevtoolsOfflineProviderFunction · 0.45
addObserverFunction · 0.45

Calls 3

onSubscribeMethod · 0.95
onUnsubscribeMethod · 0.95
addMethod · 0.45

Tested by 3

addObserverFunction · 0.36
setupFunction · 0.36
subscribeFunction · 0.36