diff --git a/docs/framework/angular/reference/classes/InfiniteQueryObserver.md b/docs/framework/angular/reference/classes/InfiniteQueryObserver.md index 0fc1765d488..5453760e839 100644 --- a/docs/framework/angular/reference/classes/InfiniteQueryObserver.md +++ b/docs/framework/angular/reference/classes/InfiniteQueryObserver.md @@ -130,7 +130,7 @@ QueryObserver.getCurrentResult protected listeners: Set>; ``` -Defined in: [packages/query-core/src/subscribable.ts:2](https://github.com/TanStack/query/blob/main/packages/query-core/src/subscribable.ts#L2) +Defined in: [packages/query-core/src/subscribable.ts:7](https://github.com/TanStack/query/blob/main/packages/query-core/src/subscribable.ts#L7) #### Inherited from @@ -160,12 +160,18 @@ subscribe: (listener: InfiniteQueryObserverListener) => () => void; Defined in: [packages/query-core/src/infiniteQueryObserver.ts:55](https://github.com/TanStack/query/blob/main/packages/query-core/src/infiniteQueryObserver.ts#L55) +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()`. + #### Parameters ##### listener `InfiniteQueryObserverListener` +Called on each update, with whatever the subclass passes to its subscribers. + #### Returns ```ts @@ -176,6 +182,16 @@ Defined in: [packages/query-core/src/infiniteQueryObserver.ts:55](https://github `void` +#### Example + +```ts +const unsubscribe = subscribable.subscribe(() => { + // react to the update +}) + +unsubscribe() +``` + #### Overrides ```ts @@ -427,7 +443,9 @@ synchronously. hasListeners(): boolean; ``` -Defined in: [packages/query-core/src/subscribable.ts:19](https://github.com/TanStack/query/blob/main/packages/query-core/src/subscribable.ts#L19) +Defined in: [packages/query-core/src/subscribable.ts:41](https://github.com/TanStack/query/blob/main/packages/query-core/src/subscribable.ts#L41) + +Returns `true` while at least one listener is registered, `false` once they have all unsubscribed. #### Returns diff --git a/docs/framework/angular/reference/classes/Mutation.md b/docs/framework/angular/reference/classes/Mutation.md index fa3b9c79522..49975b76a75 100644 --- a/docs/framework/angular/reference/classes/Mutation.md +++ b/docs/framework/angular/reference/classes/Mutation.md @@ -78,7 +78,7 @@ Removable.constructor gcTime: number; ``` -Defined in: [packages/query-core/src/removable.ts:7](https://github.com/TanStack/query/blob/main/packages/query-core/src/removable.ts#L7) +Defined in: [packages/query-core/src/removable.ts:11](https://github.com/TanStack/query/blob/main/packages/query-core/src/removable.ts#L11) #### Inherited from @@ -142,7 +142,7 @@ The `meta` object passed in the mutation's options, if any. protected clearGcTimeout(): void; ``` -Defined in: [packages/query-core/src/removable.ts:32](https://github.com/TanStack/query/blob/main/packages/query-core/src/removable.ts#L32) +Defined in: [packages/query-core/src/removable.ts:41](https://github.com/TanStack/query/blob/main/packages/query-core/src/removable.ts#L41) #### Returns @@ -199,7 +199,11 @@ await mutation?.continue() destroy(): void; ``` -Defined in: [packages/query-core/src/removable.ts:10](https://github.com/TanStack/query/blob/main/packages/query-core/src/removable.ts#L10) +Defined in: [packages/query-core/src/removable.ts:19](https://github.com/TanStack/query/blob/main/packages/query-core/src/removable.ts#L19) + +Clears the pending garbage collection timeout, so the entry is no longer scheduled for removal. +A subclass may override this to release what it holds on to as well — `Query` also cancels any +in-flight fetch. #### Returns @@ -291,7 +295,7 @@ Removable.optionalRemove protected scheduleGc(): void; ``` -Defined in: [packages/query-core/src/removable.ts:14](https://github.com/TanStack/query/blob/main/packages/query-core/src/removable.ts#L14) +Defined in: [packages/query-core/src/removable.ts:23](https://github.com/TanStack/query/blob/main/packages/query-core/src/removable.ts#L23) #### Returns @@ -311,7 +315,7 @@ Removable.scheduleGc protected updateGcTime(newGcTime: number | undefined): void; ``` -Defined in: [packages/query-core/src/removable.ts:24](https://github.com/TanStack/query/blob/main/packages/query-core/src/removable.ts#L24) +Defined in: [packages/query-core/src/removable.ts:33](https://github.com/TanStack/query/blob/main/packages/query-core/src/removable.ts#L33) #### Parameters diff --git a/docs/framework/angular/reference/classes/MutationCache.md b/docs/framework/angular/reference/classes/MutationCache.md index 65015530c74..b64b17cf0e9 100644 --- a/docs/framework/angular/reference/classes/MutationCache.md +++ b/docs/framework/angular/reference/classes/MutationCache.md @@ -67,7 +67,7 @@ Defined in: [packages/query-core/src/mutationCache.ts:129](https://github.com/Ta protected listeners: Set; ``` -Defined in: [packages/query-core/src/subscribable.ts:2](https://github.com/TanStack/query/blob/main/packages/query-core/src/subscribable.ts#L2) +Defined in: [packages/query-core/src/subscribable.ts:7](https://github.com/TanStack/query/blob/main/packages/query-core/src/subscribable.ts#L7) #### Inherited from @@ -231,7 +231,9 @@ const mutations = mutationCache.getAll() hasListeners(): boolean; ``` -Defined in: [packages/query-core/src/subscribable.ts:19](https://github.com/TanStack/query/blob/main/packages/query-core/src/subscribable.ts#L19) +Defined in: [packages/query-core/src/subscribable.ts:41](https://github.com/TanStack/query/blob/main/packages/query-core/src/subscribable.ts#L41) + +Returns `true` while at least one listener is registered, `false` once they have all unsubscribed. #### Returns @@ -251,7 +253,7 @@ Subscribable.hasListeners protected onSubscribe(): void; ``` -Defined in: [packages/query-core/src/subscribable.ts:23](https://github.com/TanStack/query/blob/main/packages/query-core/src/subscribable.ts#L23) +Defined in: [packages/query-core/src/subscribable.ts:45](https://github.com/TanStack/query/blob/main/packages/query-core/src/subscribable.ts#L45) #### Returns @@ -271,7 +273,7 @@ Subscribable.onSubscribe protected onUnsubscribe(): void; ``` -Defined in: [packages/query-core/src/subscribable.ts:27](https://github.com/TanStack/query/blob/main/packages/query-core/src/subscribable.ts#L27) +Defined in: [packages/query-core/src/subscribable.ts:49](https://github.com/TanStack/query/blob/main/packages/query-core/src/subscribable.ts#L49) #### Returns @@ -291,7 +293,11 @@ Subscribable.onUnsubscribe subscribe(listener: MutationCacheListener): () => void; ``` -Defined in: [packages/query-core/src/subscribable.ts:8](https://github.com/TanStack/query/blob/main/packages/query-core/src/subscribable.ts#L8) +Defined in: [packages/query-core/src/subscribable.ts:27](https://github.com/TanStack/query/blob/main/packages/query-core/src/subscribable.ts#L27) + +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()`. #### Parameters @@ -299,6 +305,8 @@ Defined in: [packages/query-core/src/subscribable.ts:8](https://github.com/TanSt `MutationCacheListener` +Called on each update, with whatever the subclass passes to its subscribers. + #### Returns ```ts @@ -309,6 +317,16 @@ Defined in: [packages/query-core/src/subscribable.ts:8](https://github.com/TanSt `void` +#### Example + +```ts +const unsubscribe = subscribable.subscribe(() => { + // react to the update +}) + +unsubscribe() +``` + #### Inherited from ```ts diff --git a/docs/framework/angular/reference/classes/MutationObserver.md b/docs/framework/angular/reference/classes/MutationObserver.md index 90bac0ff994..e8ba6146fb3 100644 --- a/docs/framework/angular/reference/classes/MutationObserver.md +++ b/docs/framework/angular/reference/classes/MutationObserver.md @@ -82,7 +82,7 @@ Subscribable< protected listeners: Set>; ``` -Defined in: [packages/query-core/src/subscribable.ts:2](https://github.com/TanStack/query/blob/main/packages/query-core/src/subscribable.ts#L2) +Defined in: [packages/query-core/src/subscribable.ts:7](https://github.com/TanStack/query/blob/main/packages/query-core/src/subscribable.ts#L7) #### Inherited from @@ -140,7 +140,9 @@ built yet, e.g. before the first `mutate()` call or after `reset()`). hasListeners(): boolean; ``` -Defined in: [packages/query-core/src/subscribable.ts:19](https://github.com/TanStack/query/blob/main/packages/query-core/src/subscribable.ts#L19) +Defined in: [packages/query-core/src/subscribable.ts:41](https://github.com/TanStack/query/blob/main/packages/query-core/src/subscribable.ts#L41) + +Returns `true` while at least one listener is registered, `false` once they have all unsubscribed. #### Returns @@ -310,7 +312,11 @@ observer.setOptions({ subscribe(listener: MutationObserverListener): () => void; ``` -Defined in: [packages/query-core/src/subscribable.ts:8](https://github.com/TanStack/query/blob/main/packages/query-core/src/subscribable.ts#L8) +Defined in: [packages/query-core/src/subscribable.ts:27](https://github.com/TanStack/query/blob/main/packages/query-core/src/subscribable.ts#L27) + +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()`. #### Parameters @@ -318,6 +324,8 @@ Defined in: [packages/query-core/src/subscribable.ts:8](https://github.com/TanSt `MutationObserverListener` +Called on each update, with whatever the subclass passes to its subscribers. + #### Returns ```ts @@ -328,6 +336,16 @@ Defined in: [packages/query-core/src/subscribable.ts:8](https://github.com/TanSt `void` +#### Example + +```ts +const unsubscribe = subscribable.subscribe(() => { + // react to the update +}) + +unsubscribe() +``` + #### Inherited from ```ts diff --git a/docs/framework/angular/reference/classes/QueriesObserver.md b/docs/framework/angular/reference/classes/QueriesObserver.md index 8bf48fdbebe..ebcbcd9cc97 100644 --- a/docs/framework/angular/reference/classes/QueriesObserver.md +++ b/docs/framework/angular/reference/classes/QueriesObserver.md @@ -79,7 +79,7 @@ Subscribable.constructor protected listeners: Set; ``` -Defined in: [packages/query-core/src/subscribable.ts:2](https://github.com/TanStack/query/blob/main/packages/query-core/src/subscribable.ts#L2) +Defined in: [packages/query-core/src/subscribable.ts:7](https://github.com/TanStack/query/blob/main/packages/query-core/src/subscribable.ts#L7) #### Inherited from @@ -202,7 +202,9 @@ the same order as the queries passed to the constructor or `setQueries`. hasListeners(): boolean; ``` -Defined in: [packages/query-core/src/subscribable.ts:19](https://github.com/TanStack/query/blob/main/packages/query-core/src/subscribable.ts#L19) +Defined in: [packages/query-core/src/subscribable.ts:41](https://github.com/TanStack/query/blob/main/packages/query-core/src/subscribable.ts#L41) + +Returns `true` while at least one listener is registered, `false` once they have all unsubscribed. #### Returns @@ -300,7 +302,11 @@ observer.setQueries([ subscribe(listener: QueriesObserverListener): () => void; ``` -Defined in: [packages/query-core/src/subscribable.ts:8](https://github.com/TanStack/query/blob/main/packages/query-core/src/subscribable.ts#L8) +Defined in: [packages/query-core/src/subscribable.ts:27](https://github.com/TanStack/query/blob/main/packages/query-core/src/subscribable.ts#L27) + +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()`. #### Parameters @@ -308,6 +314,8 @@ Defined in: [packages/query-core/src/subscribable.ts:8](https://github.com/TanSt `QueriesObserverListener` +Called on each update, with whatever the subclass passes to its subscribers. + #### Returns ```ts @@ -318,6 +326,16 @@ Defined in: [packages/query-core/src/subscribable.ts:8](https://github.com/TanSt `void` +#### Example + +```ts +const unsubscribe = subscribable.subscribe(() => { + // react to the update +}) + +unsubscribe() +``` + #### Inherited from ```ts diff --git a/docs/framework/angular/reference/classes/Query.md b/docs/framework/angular/reference/classes/Query.md index fee2fb07529..646028952e1 100644 --- a/docs/framework/angular/reference/classes/Query.md +++ b/docs/framework/angular/reference/classes/Query.md @@ -80,7 +80,7 @@ Removable.constructor gcTime: number; ``` -Defined in: [packages/query-core/src/removable.ts:7](https://github.com/TanStack/query/blob/main/packages/query-core/src/removable.ts#L7) +Defined in: [packages/query-core/src/removable.ts:11](https://github.com/TanStack/query/blob/main/packages/query-core/src/removable.ts#L11) #### Inherited from @@ -213,7 +213,7 @@ await query.cancel() protected clearGcTimeout(): void; ``` -Defined in: [packages/query-core/src/removable.ts:32](https://github.com/TanStack/query/blob/main/packages/query-core/src/removable.ts#L32) +Defined in: [packages/query-core/src/removable.ts:41](https://github.com/TanStack/query/blob/main/packages/query-core/src/removable.ts#L41) #### Returns @@ -522,7 +522,7 @@ in-flight fetch. protected scheduleGc(): void; ``` -Defined in: [packages/query-core/src/removable.ts:14](https://github.com/TanStack/query/blob/main/packages/query-core/src/removable.ts#L14) +Defined in: [packages/query-core/src/removable.ts:23](https://github.com/TanStack/query/blob/main/packages/query-core/src/removable.ts#L23) #### Returns @@ -566,7 +566,7 @@ user manually trigger a loading/error state or edit the cached data. protected updateGcTime(newGcTime: number | undefined): void; ``` -Defined in: [packages/query-core/src/removable.ts:24](https://github.com/TanStack/query/blob/main/packages/query-core/src/removable.ts#L24) +Defined in: [packages/query-core/src/removable.ts:33](https://github.com/TanStack/query/blob/main/packages/query-core/src/removable.ts#L33) #### Parameters diff --git a/docs/framework/angular/reference/classes/QueryCache.md b/docs/framework/angular/reference/classes/QueryCache.md index 982a6e72fb9..18520030db7 100644 --- a/docs/framework/angular/reference/classes/QueryCache.md +++ b/docs/framework/angular/reference/classes/QueryCache.md @@ -70,7 +70,7 @@ Defined in: [packages/query-core/src/queryCache.ts:126](https://github.com/TanSt protected listeners: Set; ``` -Defined in: [packages/query-core/src/subscribable.ts:2](https://github.com/TanStack/query/blob/main/packages/query-core/src/subscribable.ts#L2) +Defined in: [packages/query-core/src/subscribable.ts:7](https://github.com/TanStack/query/blob/main/packages/query-core/src/subscribable.ts#L7) #### Inherited from @@ -350,7 +350,9 @@ const queries = queryCache.getAll() hasListeners(): boolean; ``` -Defined in: [packages/query-core/src/subscribable.ts:19](https://github.com/TanStack/query/blob/main/packages/query-core/src/subscribable.ts#L19) +Defined in: [packages/query-core/src/subscribable.ts:41](https://github.com/TanStack/query/blob/main/packages/query-core/src/subscribable.ts#L41) + +Returns `true` while at least one listener is registered, `false` once they have all unsubscribed. #### Returns @@ -370,7 +372,7 @@ Subscribable.hasListeners protected onSubscribe(): void; ``` -Defined in: [packages/query-core/src/subscribable.ts:23](https://github.com/TanStack/query/blob/main/packages/query-core/src/subscribable.ts#L23) +Defined in: [packages/query-core/src/subscribable.ts:45](https://github.com/TanStack/query/blob/main/packages/query-core/src/subscribable.ts#L45) #### Returns @@ -390,7 +392,7 @@ Subscribable.onSubscribe protected onUnsubscribe(): void; ``` -Defined in: [packages/query-core/src/subscribable.ts:27](https://github.com/TanStack/query/blob/main/packages/query-core/src/subscribable.ts#L27) +Defined in: [packages/query-core/src/subscribable.ts:49](https://github.com/TanStack/query/blob/main/packages/query-core/src/subscribable.ts#L49) #### Returns @@ -446,7 +448,11 @@ if (query) { subscribe(listener: QueryCacheListener): () => void; ``` -Defined in: [packages/query-core/src/subscribable.ts:8](https://github.com/TanStack/query/blob/main/packages/query-core/src/subscribable.ts#L8) +Defined in: [packages/query-core/src/subscribable.ts:27](https://github.com/TanStack/query/blob/main/packages/query-core/src/subscribable.ts#L27) + +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()`. #### Parameters @@ -454,6 +460,8 @@ Defined in: [packages/query-core/src/subscribable.ts:8](https://github.com/TanSt `QueryCacheListener` +Called on each update, with whatever the subclass passes to its subscribers. + #### Returns ```ts @@ -464,6 +472,16 @@ Defined in: [packages/query-core/src/subscribable.ts:8](https://github.com/TanSt `void` +#### Example + +```ts +const unsubscribe = subscribable.subscribe(() => { + // react to the update +}) + +unsubscribe() +``` + #### Inherited from ```ts diff --git a/docs/framework/angular/reference/classes/QueryObserver.md b/docs/framework/angular/reference/classes/QueryObserver.md index 8f5dd48169e..ba20c873925 100644 --- a/docs/framework/angular/reference/classes/QueryObserver.md +++ b/docs/framework/angular/reference/classes/QueryObserver.md @@ -93,7 +93,7 @@ Subscribable>.constructor protected listeners: Set>; ``` -Defined in: [packages/query-core/src/subscribable.ts:2](https://github.com/TanStack/query/blob/main/packages/query-core/src/subscribable.ts#L2) +Defined in: [packages/query-core/src/subscribable.ts:7](https://github.com/TanStack/query/blob/main/packages/query-core/src/subscribable.ts#L7) #### Inherited from @@ -298,7 +298,9 @@ returned value is available synchronously, ahead of `setOptions` triggering an a hasListeners(): boolean; ``` -Defined in: [packages/query-core/src/subscribable.ts:19](https://github.com/TanStack/query/blob/main/packages/query-core/src/subscribable.ts#L19) +Defined in: [packages/query-core/src/subscribable.ts:41](https://github.com/TanStack/query/blob/main/packages/query-core/src/subscribable.ts#L41) + +Returns `true` while at least one listener is registered, `false` once they have all unsubscribed. #### Returns @@ -458,7 +460,11 @@ regains focus. subscribe(listener: QueryObserverListener): () => void; ``` -Defined in: [packages/query-core/src/subscribable.ts:8](https://github.com/TanStack/query/blob/main/packages/query-core/src/subscribable.ts#L8) +Defined in: [packages/query-core/src/subscribable.ts:27](https://github.com/TanStack/query/blob/main/packages/query-core/src/subscribable.ts#L27) + +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()`. #### Parameters @@ -466,6 +472,8 @@ Defined in: [packages/query-core/src/subscribable.ts:8](https://github.com/TanSt `QueryObserverListener` +Called on each update, with whatever the subclass passes to its subscribers. + #### Returns ```ts @@ -476,6 +484,16 @@ Defined in: [packages/query-core/src/subscribable.ts:8](https://github.com/TanSt `void` +#### Example + +```ts +const unsubscribe = subscribable.subscribe(() => { + // react to the update +}) + +unsubscribe() +``` + #### Inherited from ```ts diff --git a/docs/framework/angular/reference/interfaces/FocusManager.md b/docs/framework/angular/reference/interfaces/FocusManager.md index 63e0813388a..c0e6c1dcf22 100644 --- a/docs/framework/angular/reference/interfaces/FocusManager.md +++ b/docs/framework/angular/reference/interfaces/FocusManager.md @@ -27,7 +27,9 @@ It can be used to change the default event listeners or to manually change the f hasListeners(): boolean; ``` -Defined in: [packages/query-core/src/subscribable.ts:19](https://github.com/TanStack/query/blob/main/packages/query-core/src/subscribable.ts#L19) +Defined in: [packages/query-core/src/subscribable.ts:41](https://github.com/TanStack/query/blob/main/packages/query-core/src/subscribable.ts#L41) + +Returns `true` while at least one listener is registered, `false` once they have all unsubscribed. #### Returns @@ -202,7 +204,11 @@ focusManager.setFocused(undefined) subscribe(listener: Listener): () => void; ``` -Defined in: [packages/query-core/src/subscribable.ts:8](https://github.com/TanStack/query/blob/main/packages/query-core/src/subscribable.ts#L8) +Defined in: [packages/query-core/src/subscribable.ts:27](https://github.com/TanStack/query/blob/main/packages/query-core/src/subscribable.ts#L27) + +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()`. #### Parameters @@ -210,6 +216,8 @@ Defined in: [packages/query-core/src/subscribable.ts:8](https://github.com/TanSt `Listener` +Called on each update, with whatever the subclass passes to its subscribers. + #### Returns ```ts @@ -220,6 +228,16 @@ Defined in: [packages/query-core/src/subscribable.ts:8](https://github.com/TanSt `void` +#### Example + +```ts +const unsubscribe = subscribable.subscribe(() => { + // react to the update +}) + +unsubscribe() +``` + #### Inherited from ```ts diff --git a/docs/framework/angular/reference/interfaces/OnlineManager.md b/docs/framework/angular/reference/interfaces/OnlineManager.md index 6f0f71074db..e9f911fce4e 100644 --- a/docs/framework/angular/reference/interfaces/OnlineManager.md +++ b/docs/framework/angular/reference/interfaces/OnlineManager.md @@ -31,7 +31,9 @@ detect changes. hasListeners(): boolean; ``` -Defined in: [packages/query-core/src/subscribable.ts:19](https://github.com/TanStack/query/blob/main/packages/query-core/src/subscribable.ts#L19) +Defined in: [packages/query-core/src/subscribable.ts:41](https://github.com/TanStack/query/blob/main/packages/query-core/src/subscribable.ts#L41) + +Returns `true` while at least one listener is registered, `false` once they have all unsubscribed. #### Returns @@ -179,7 +181,11 @@ onlineManager.setOnline(false) subscribe(listener: Listener): () => void; ``` -Defined in: [packages/query-core/src/subscribable.ts:8](https://github.com/TanStack/query/blob/main/packages/query-core/src/subscribable.ts#L8) +Defined in: [packages/query-core/src/subscribable.ts:27](https://github.com/TanStack/query/blob/main/packages/query-core/src/subscribable.ts#L27) + +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()`. #### Parameters @@ -187,6 +193,8 @@ Defined in: [packages/query-core/src/subscribable.ts:8](https://github.com/TanSt `Listener` +Called on each update, with whatever the subclass passes to its subscribers. + #### Returns ```ts @@ -197,6 +205,16 @@ Defined in: [packages/query-core/src/subscribable.ts:8](https://github.com/TanSt `void` +#### Example + +```ts +const unsubscribe = subscribable.subscribe(() => { + // react to the update +}) + +unsubscribe() +``` + #### Inherited from ```ts diff --git a/docs/framework/lit/reference/classes/InfiniteQueryObserver.md b/docs/framework/lit/reference/classes/InfiniteQueryObserver.md index 9aed0a23afa..5d1100d8f32 100644 --- a/docs/framework/lit/reference/classes/InfiniteQueryObserver.md +++ b/docs/framework/lit/reference/classes/InfiniteQueryObserver.md @@ -130,7 +130,7 @@ QueryObserver.getCurrentResult protected listeners: Set>; ``` -Defined in: [packages/query-core/src/subscribable.ts:2](https://github.com/TanStack/query/blob/main/packages/query-core/src/subscribable.ts#L2) +Defined in: [packages/query-core/src/subscribable.ts:7](https://github.com/TanStack/query/blob/main/packages/query-core/src/subscribable.ts#L7) #### Inherited from @@ -160,12 +160,18 @@ subscribe: (listener: InfiniteQueryObserverListener) => () => void; Defined in: [packages/query-core/src/infiniteQueryObserver.ts:55](https://github.com/TanStack/query/blob/main/packages/query-core/src/infiniteQueryObserver.ts#L55) +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()`. + #### Parameters ##### listener `InfiniteQueryObserverListener` +Called on each update, with whatever the subclass passes to its subscribers. + #### Returns ```ts @@ -176,6 +182,16 @@ Defined in: [packages/query-core/src/infiniteQueryObserver.ts:55](https://github `void` +#### Example + +```ts +const unsubscribe = subscribable.subscribe(() => { + // react to the update +}) + +unsubscribe() +``` + #### Overrides ```ts @@ -427,7 +443,9 @@ synchronously. hasListeners(): boolean; ``` -Defined in: [packages/query-core/src/subscribable.ts:19](https://github.com/TanStack/query/blob/main/packages/query-core/src/subscribable.ts#L19) +Defined in: [packages/query-core/src/subscribable.ts:41](https://github.com/TanStack/query/blob/main/packages/query-core/src/subscribable.ts#L41) + +Returns `true` while at least one listener is registered, `false` once they have all unsubscribed. #### Returns diff --git a/docs/framework/lit/reference/classes/Mutation.md b/docs/framework/lit/reference/classes/Mutation.md index fa3b9c79522..49975b76a75 100644 --- a/docs/framework/lit/reference/classes/Mutation.md +++ b/docs/framework/lit/reference/classes/Mutation.md @@ -78,7 +78,7 @@ Removable.constructor gcTime: number; ``` -Defined in: [packages/query-core/src/removable.ts:7](https://github.com/TanStack/query/blob/main/packages/query-core/src/removable.ts#L7) +Defined in: [packages/query-core/src/removable.ts:11](https://github.com/TanStack/query/blob/main/packages/query-core/src/removable.ts#L11) #### Inherited from @@ -142,7 +142,7 @@ The `meta` object passed in the mutation's options, if any. protected clearGcTimeout(): void; ``` -Defined in: [packages/query-core/src/removable.ts:32](https://github.com/TanStack/query/blob/main/packages/query-core/src/removable.ts#L32) +Defined in: [packages/query-core/src/removable.ts:41](https://github.com/TanStack/query/blob/main/packages/query-core/src/removable.ts#L41) #### Returns @@ -199,7 +199,11 @@ await mutation?.continue() destroy(): void; ``` -Defined in: [packages/query-core/src/removable.ts:10](https://github.com/TanStack/query/blob/main/packages/query-core/src/removable.ts#L10) +Defined in: [packages/query-core/src/removable.ts:19](https://github.com/TanStack/query/blob/main/packages/query-core/src/removable.ts#L19) + +Clears the pending garbage collection timeout, so the entry is no longer scheduled for removal. +A subclass may override this to release what it holds on to as well — `Query` also cancels any +in-flight fetch. #### Returns @@ -291,7 +295,7 @@ Removable.optionalRemove protected scheduleGc(): void; ``` -Defined in: [packages/query-core/src/removable.ts:14](https://github.com/TanStack/query/blob/main/packages/query-core/src/removable.ts#L14) +Defined in: [packages/query-core/src/removable.ts:23](https://github.com/TanStack/query/blob/main/packages/query-core/src/removable.ts#L23) #### Returns @@ -311,7 +315,7 @@ Removable.scheduleGc protected updateGcTime(newGcTime: number | undefined): void; ``` -Defined in: [packages/query-core/src/removable.ts:24](https://github.com/TanStack/query/blob/main/packages/query-core/src/removable.ts#L24) +Defined in: [packages/query-core/src/removable.ts:33](https://github.com/TanStack/query/blob/main/packages/query-core/src/removable.ts#L33) #### Parameters diff --git a/docs/framework/lit/reference/classes/MutationCache.md b/docs/framework/lit/reference/classes/MutationCache.md index 4b193f45424..044c175e09c 100644 --- a/docs/framework/lit/reference/classes/MutationCache.md +++ b/docs/framework/lit/reference/classes/MutationCache.md @@ -67,7 +67,7 @@ Defined in: [packages/query-core/src/mutationCache.ts:129](https://github.com/Ta protected listeners: Set; ``` -Defined in: [packages/query-core/src/subscribable.ts:2](https://github.com/TanStack/query/blob/main/packages/query-core/src/subscribable.ts#L2) +Defined in: [packages/query-core/src/subscribable.ts:7](https://github.com/TanStack/query/blob/main/packages/query-core/src/subscribable.ts#L7) #### Inherited from @@ -231,7 +231,9 @@ const mutations = mutationCache.getAll() hasListeners(): boolean; ``` -Defined in: [packages/query-core/src/subscribable.ts:19](https://github.com/TanStack/query/blob/main/packages/query-core/src/subscribable.ts#L19) +Defined in: [packages/query-core/src/subscribable.ts:41](https://github.com/TanStack/query/blob/main/packages/query-core/src/subscribable.ts#L41) + +Returns `true` while at least one listener is registered, `false` once they have all unsubscribed. #### Returns @@ -251,7 +253,7 @@ Subscribable.hasListeners protected onSubscribe(): void; ``` -Defined in: [packages/query-core/src/subscribable.ts:23](https://github.com/TanStack/query/blob/main/packages/query-core/src/subscribable.ts#L23) +Defined in: [packages/query-core/src/subscribable.ts:45](https://github.com/TanStack/query/blob/main/packages/query-core/src/subscribable.ts#L45) #### Returns @@ -271,7 +273,7 @@ Subscribable.onSubscribe protected onUnsubscribe(): void; ``` -Defined in: [packages/query-core/src/subscribable.ts:27](https://github.com/TanStack/query/blob/main/packages/query-core/src/subscribable.ts#L27) +Defined in: [packages/query-core/src/subscribable.ts:49](https://github.com/TanStack/query/blob/main/packages/query-core/src/subscribable.ts#L49) #### Returns @@ -291,7 +293,11 @@ Subscribable.onUnsubscribe subscribe(listener: MutationCacheListener): () => void; ``` -Defined in: [packages/query-core/src/subscribable.ts:8](https://github.com/TanStack/query/blob/main/packages/query-core/src/subscribable.ts#L8) +Defined in: [packages/query-core/src/subscribable.ts:27](https://github.com/TanStack/query/blob/main/packages/query-core/src/subscribable.ts#L27) + +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()`. #### Parameters @@ -299,6 +305,8 @@ Defined in: [packages/query-core/src/subscribable.ts:8](https://github.com/TanSt `MutationCacheListener` +Called on each update, with whatever the subclass passes to its subscribers. + #### Returns ```ts @@ -309,6 +317,16 @@ Defined in: [packages/query-core/src/subscribable.ts:8](https://github.com/TanSt `void` +#### Example + +```ts +const unsubscribe = subscribable.subscribe(() => { + // react to the update +}) + +unsubscribe() +``` + #### Inherited from ```ts diff --git a/docs/framework/lit/reference/classes/MutationObserver.md b/docs/framework/lit/reference/classes/MutationObserver.md index 90bac0ff994..e8ba6146fb3 100644 --- a/docs/framework/lit/reference/classes/MutationObserver.md +++ b/docs/framework/lit/reference/classes/MutationObserver.md @@ -82,7 +82,7 @@ Subscribable< protected listeners: Set>; ``` -Defined in: [packages/query-core/src/subscribable.ts:2](https://github.com/TanStack/query/blob/main/packages/query-core/src/subscribable.ts#L2) +Defined in: [packages/query-core/src/subscribable.ts:7](https://github.com/TanStack/query/blob/main/packages/query-core/src/subscribable.ts#L7) #### Inherited from @@ -140,7 +140,9 @@ built yet, e.g. before the first `mutate()` call or after `reset()`). hasListeners(): boolean; ``` -Defined in: [packages/query-core/src/subscribable.ts:19](https://github.com/TanStack/query/blob/main/packages/query-core/src/subscribable.ts#L19) +Defined in: [packages/query-core/src/subscribable.ts:41](https://github.com/TanStack/query/blob/main/packages/query-core/src/subscribable.ts#L41) + +Returns `true` while at least one listener is registered, `false` once they have all unsubscribed. #### Returns @@ -310,7 +312,11 @@ observer.setOptions({ subscribe(listener: MutationObserverListener): () => void; ``` -Defined in: [packages/query-core/src/subscribable.ts:8](https://github.com/TanStack/query/blob/main/packages/query-core/src/subscribable.ts#L8) +Defined in: [packages/query-core/src/subscribable.ts:27](https://github.com/TanStack/query/blob/main/packages/query-core/src/subscribable.ts#L27) + +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()`. #### Parameters @@ -318,6 +324,8 @@ Defined in: [packages/query-core/src/subscribable.ts:8](https://github.com/TanSt `MutationObserverListener` +Called on each update, with whatever the subclass passes to its subscribers. + #### Returns ```ts @@ -328,6 +336,16 @@ Defined in: [packages/query-core/src/subscribable.ts:8](https://github.com/TanSt `void` +#### Example + +```ts +const unsubscribe = subscribable.subscribe(() => { + // react to the update +}) + +unsubscribe() +``` + #### Inherited from ```ts diff --git a/docs/framework/lit/reference/classes/QueriesObserver.md b/docs/framework/lit/reference/classes/QueriesObserver.md index 42841eaddf8..534795417f2 100644 --- a/docs/framework/lit/reference/classes/QueriesObserver.md +++ b/docs/framework/lit/reference/classes/QueriesObserver.md @@ -79,7 +79,7 @@ Subscribable.constructor protected listeners: Set; ``` -Defined in: [packages/query-core/src/subscribable.ts:2](https://github.com/TanStack/query/blob/main/packages/query-core/src/subscribable.ts#L2) +Defined in: [packages/query-core/src/subscribable.ts:7](https://github.com/TanStack/query/blob/main/packages/query-core/src/subscribable.ts#L7) #### Inherited from @@ -202,7 +202,9 @@ the same order as the queries passed to the constructor or `setQueries`. hasListeners(): boolean; ``` -Defined in: [packages/query-core/src/subscribable.ts:19](https://github.com/TanStack/query/blob/main/packages/query-core/src/subscribable.ts#L19) +Defined in: [packages/query-core/src/subscribable.ts:41](https://github.com/TanStack/query/blob/main/packages/query-core/src/subscribable.ts#L41) + +Returns `true` while at least one listener is registered, `false` once they have all unsubscribed. #### Returns @@ -300,7 +302,11 @@ observer.setQueries([ subscribe(listener: QueriesObserverListener): () => void; ``` -Defined in: [packages/query-core/src/subscribable.ts:8](https://github.com/TanStack/query/blob/main/packages/query-core/src/subscribable.ts#L8) +Defined in: [packages/query-core/src/subscribable.ts:27](https://github.com/TanStack/query/blob/main/packages/query-core/src/subscribable.ts#L27) + +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()`. #### Parameters @@ -308,6 +314,8 @@ Defined in: [packages/query-core/src/subscribable.ts:8](https://github.com/TanSt `QueriesObserverListener` +Called on each update, with whatever the subclass passes to its subscribers. + #### Returns ```ts @@ -318,6 +326,16 @@ Defined in: [packages/query-core/src/subscribable.ts:8](https://github.com/TanSt `void` +#### Example + +```ts +const unsubscribe = subscribable.subscribe(() => { + // react to the update +}) + +unsubscribe() +``` + #### Inherited from ```ts diff --git a/docs/framework/lit/reference/classes/Query.md b/docs/framework/lit/reference/classes/Query.md index fee2fb07529..646028952e1 100644 --- a/docs/framework/lit/reference/classes/Query.md +++ b/docs/framework/lit/reference/classes/Query.md @@ -80,7 +80,7 @@ Removable.constructor gcTime: number; ``` -Defined in: [packages/query-core/src/removable.ts:7](https://github.com/TanStack/query/blob/main/packages/query-core/src/removable.ts#L7) +Defined in: [packages/query-core/src/removable.ts:11](https://github.com/TanStack/query/blob/main/packages/query-core/src/removable.ts#L11) #### Inherited from @@ -213,7 +213,7 @@ await query.cancel() protected clearGcTimeout(): void; ``` -Defined in: [packages/query-core/src/removable.ts:32](https://github.com/TanStack/query/blob/main/packages/query-core/src/removable.ts#L32) +Defined in: [packages/query-core/src/removable.ts:41](https://github.com/TanStack/query/blob/main/packages/query-core/src/removable.ts#L41) #### Returns @@ -522,7 +522,7 @@ in-flight fetch. protected scheduleGc(): void; ``` -Defined in: [packages/query-core/src/removable.ts:14](https://github.com/TanStack/query/blob/main/packages/query-core/src/removable.ts#L14) +Defined in: [packages/query-core/src/removable.ts:23](https://github.com/TanStack/query/blob/main/packages/query-core/src/removable.ts#L23) #### Returns @@ -566,7 +566,7 @@ user manually trigger a loading/error state or edit the cached data. protected updateGcTime(newGcTime: number | undefined): void; ``` -Defined in: [packages/query-core/src/removable.ts:24](https://github.com/TanStack/query/blob/main/packages/query-core/src/removable.ts#L24) +Defined in: [packages/query-core/src/removable.ts:33](https://github.com/TanStack/query/blob/main/packages/query-core/src/removable.ts#L33) #### Parameters diff --git a/docs/framework/lit/reference/classes/QueryCache.md b/docs/framework/lit/reference/classes/QueryCache.md index 2f05591bd63..7e3862d763a 100644 --- a/docs/framework/lit/reference/classes/QueryCache.md +++ b/docs/framework/lit/reference/classes/QueryCache.md @@ -70,7 +70,7 @@ Defined in: [packages/query-core/src/queryCache.ts:126](https://github.com/TanSt protected listeners: Set; ``` -Defined in: [packages/query-core/src/subscribable.ts:2](https://github.com/TanStack/query/blob/main/packages/query-core/src/subscribable.ts#L2) +Defined in: [packages/query-core/src/subscribable.ts:7](https://github.com/TanStack/query/blob/main/packages/query-core/src/subscribable.ts#L7) #### Inherited from @@ -350,7 +350,9 @@ const queries = queryCache.getAll() hasListeners(): boolean; ``` -Defined in: [packages/query-core/src/subscribable.ts:19](https://github.com/TanStack/query/blob/main/packages/query-core/src/subscribable.ts#L19) +Defined in: [packages/query-core/src/subscribable.ts:41](https://github.com/TanStack/query/blob/main/packages/query-core/src/subscribable.ts#L41) + +Returns `true` while at least one listener is registered, `false` once they have all unsubscribed. #### Returns @@ -370,7 +372,7 @@ Subscribable.hasListeners protected onSubscribe(): void; ``` -Defined in: [packages/query-core/src/subscribable.ts:23](https://github.com/TanStack/query/blob/main/packages/query-core/src/subscribable.ts#L23) +Defined in: [packages/query-core/src/subscribable.ts:45](https://github.com/TanStack/query/blob/main/packages/query-core/src/subscribable.ts#L45) #### Returns @@ -390,7 +392,7 @@ Subscribable.onSubscribe protected onUnsubscribe(): void; ``` -Defined in: [packages/query-core/src/subscribable.ts:27](https://github.com/TanStack/query/blob/main/packages/query-core/src/subscribable.ts#L27) +Defined in: [packages/query-core/src/subscribable.ts:49](https://github.com/TanStack/query/blob/main/packages/query-core/src/subscribable.ts#L49) #### Returns @@ -446,7 +448,11 @@ if (query) { subscribe(listener: QueryCacheListener): () => void; ``` -Defined in: [packages/query-core/src/subscribable.ts:8](https://github.com/TanStack/query/blob/main/packages/query-core/src/subscribable.ts#L8) +Defined in: [packages/query-core/src/subscribable.ts:27](https://github.com/TanStack/query/blob/main/packages/query-core/src/subscribable.ts#L27) + +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()`. #### Parameters @@ -454,6 +460,8 @@ Defined in: [packages/query-core/src/subscribable.ts:8](https://github.com/TanSt `QueryCacheListener` +Called on each update, with whatever the subclass passes to its subscribers. + #### Returns ```ts @@ -464,6 +472,16 @@ Defined in: [packages/query-core/src/subscribable.ts:8](https://github.com/TanSt `void` +#### Example + +```ts +const unsubscribe = subscribable.subscribe(() => { + // react to the update +}) + +unsubscribe() +``` + #### Inherited from ```ts diff --git a/docs/framework/lit/reference/classes/QueryObserver.md b/docs/framework/lit/reference/classes/QueryObserver.md index 3cdbfaf4984..efa1e07075c 100644 --- a/docs/framework/lit/reference/classes/QueryObserver.md +++ b/docs/framework/lit/reference/classes/QueryObserver.md @@ -93,7 +93,7 @@ Subscribable>.constructor protected listeners: Set>; ``` -Defined in: [packages/query-core/src/subscribable.ts:2](https://github.com/TanStack/query/blob/main/packages/query-core/src/subscribable.ts#L2) +Defined in: [packages/query-core/src/subscribable.ts:7](https://github.com/TanStack/query/blob/main/packages/query-core/src/subscribable.ts#L7) #### Inherited from @@ -298,7 +298,9 @@ returned value is available synchronously, ahead of `setOptions` triggering an a hasListeners(): boolean; ``` -Defined in: [packages/query-core/src/subscribable.ts:19](https://github.com/TanStack/query/blob/main/packages/query-core/src/subscribable.ts#L19) +Defined in: [packages/query-core/src/subscribable.ts:41](https://github.com/TanStack/query/blob/main/packages/query-core/src/subscribable.ts#L41) + +Returns `true` while at least one listener is registered, `false` once they have all unsubscribed. #### Returns @@ -458,7 +460,11 @@ regains focus. subscribe(listener: QueryObserverListener): () => void; ``` -Defined in: [packages/query-core/src/subscribable.ts:8](https://github.com/TanStack/query/blob/main/packages/query-core/src/subscribable.ts#L8) +Defined in: [packages/query-core/src/subscribable.ts:27](https://github.com/TanStack/query/blob/main/packages/query-core/src/subscribable.ts#L27) + +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()`. #### Parameters @@ -466,6 +472,8 @@ Defined in: [packages/query-core/src/subscribable.ts:8](https://github.com/TanSt `QueryObserverListener` +Called on each update, with whatever the subclass passes to its subscribers. + #### Returns ```ts @@ -476,6 +484,16 @@ Defined in: [packages/query-core/src/subscribable.ts:8](https://github.com/TanSt `void` +#### Example + +```ts +const unsubscribe = subscribable.subscribe(() => { + // react to the update +}) + +unsubscribe() +``` + #### Inherited from ```ts diff --git a/docs/framework/lit/reference/interfaces/FocusManager.md b/docs/framework/lit/reference/interfaces/FocusManager.md index 63e0813388a..c0e6c1dcf22 100644 --- a/docs/framework/lit/reference/interfaces/FocusManager.md +++ b/docs/framework/lit/reference/interfaces/FocusManager.md @@ -27,7 +27,9 @@ It can be used to change the default event listeners or to manually change the f hasListeners(): boolean; ``` -Defined in: [packages/query-core/src/subscribable.ts:19](https://github.com/TanStack/query/blob/main/packages/query-core/src/subscribable.ts#L19) +Defined in: [packages/query-core/src/subscribable.ts:41](https://github.com/TanStack/query/blob/main/packages/query-core/src/subscribable.ts#L41) + +Returns `true` while at least one listener is registered, `false` once they have all unsubscribed. #### Returns @@ -202,7 +204,11 @@ focusManager.setFocused(undefined) subscribe(listener: Listener): () => void; ``` -Defined in: [packages/query-core/src/subscribable.ts:8](https://github.com/TanStack/query/blob/main/packages/query-core/src/subscribable.ts#L8) +Defined in: [packages/query-core/src/subscribable.ts:27](https://github.com/TanStack/query/blob/main/packages/query-core/src/subscribable.ts#L27) + +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()`. #### Parameters @@ -210,6 +216,8 @@ Defined in: [packages/query-core/src/subscribable.ts:8](https://github.com/TanSt `Listener` +Called on each update, with whatever the subclass passes to its subscribers. + #### Returns ```ts @@ -220,6 +228,16 @@ Defined in: [packages/query-core/src/subscribable.ts:8](https://github.com/TanSt `void` +#### Example + +```ts +const unsubscribe = subscribable.subscribe(() => { + // react to the update +}) + +unsubscribe() +``` + #### Inherited from ```ts diff --git a/docs/framework/lit/reference/interfaces/OnlineManager.md b/docs/framework/lit/reference/interfaces/OnlineManager.md index 6f0f71074db..e9f911fce4e 100644 --- a/docs/framework/lit/reference/interfaces/OnlineManager.md +++ b/docs/framework/lit/reference/interfaces/OnlineManager.md @@ -31,7 +31,9 @@ detect changes. hasListeners(): boolean; ``` -Defined in: [packages/query-core/src/subscribable.ts:19](https://github.com/TanStack/query/blob/main/packages/query-core/src/subscribable.ts#L19) +Defined in: [packages/query-core/src/subscribable.ts:41](https://github.com/TanStack/query/blob/main/packages/query-core/src/subscribable.ts#L41) + +Returns `true` while at least one listener is registered, `false` once they have all unsubscribed. #### Returns @@ -179,7 +181,11 @@ onlineManager.setOnline(false) subscribe(listener: Listener): () => void; ``` -Defined in: [packages/query-core/src/subscribable.ts:8](https://github.com/TanStack/query/blob/main/packages/query-core/src/subscribable.ts#L8) +Defined in: [packages/query-core/src/subscribable.ts:27](https://github.com/TanStack/query/blob/main/packages/query-core/src/subscribable.ts#L27) + +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()`. #### Parameters @@ -187,6 +193,8 @@ Defined in: [packages/query-core/src/subscribable.ts:8](https://github.com/TanSt `Listener` +Called on each update, with whatever the subclass passes to its subscribers. + #### Returns ```ts @@ -197,6 +205,16 @@ Defined in: [packages/query-core/src/subscribable.ts:8](https://github.com/TanSt `void` +#### Example + +```ts +const unsubscribe = subscribable.subscribe(() => { + // react to the update +}) + +unsubscribe() +``` + #### Inherited from ```ts diff --git a/docs/framework/preact/reference/classes/InfiniteQueryObserver.md b/docs/framework/preact/reference/classes/InfiniteQueryObserver.md index 0fc1765d488..5453760e839 100644 --- a/docs/framework/preact/reference/classes/InfiniteQueryObserver.md +++ b/docs/framework/preact/reference/classes/InfiniteQueryObserver.md @@ -130,7 +130,7 @@ QueryObserver.getCurrentResult protected listeners: Set>; ``` -Defined in: [packages/query-core/src/subscribable.ts:2](https://github.com/TanStack/query/blob/main/packages/query-core/src/subscribable.ts#L2) +Defined in: [packages/query-core/src/subscribable.ts:7](https://github.com/TanStack/query/blob/main/packages/query-core/src/subscribable.ts#L7) #### Inherited from @@ -160,12 +160,18 @@ subscribe: (listener: InfiniteQueryObserverListener) => () => void; Defined in: [packages/query-core/src/infiniteQueryObserver.ts:55](https://github.com/TanStack/query/blob/main/packages/query-core/src/infiniteQueryObserver.ts#L55) +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()`. + #### Parameters ##### listener `InfiniteQueryObserverListener` +Called on each update, with whatever the subclass passes to its subscribers. + #### Returns ```ts @@ -176,6 +182,16 @@ Defined in: [packages/query-core/src/infiniteQueryObserver.ts:55](https://github `void` +#### Example + +```ts +const unsubscribe = subscribable.subscribe(() => { + // react to the update +}) + +unsubscribe() +``` + #### Overrides ```ts @@ -427,7 +443,9 @@ synchronously. hasListeners(): boolean; ``` -Defined in: [packages/query-core/src/subscribable.ts:19](https://github.com/TanStack/query/blob/main/packages/query-core/src/subscribable.ts#L19) +Defined in: [packages/query-core/src/subscribable.ts:41](https://github.com/TanStack/query/blob/main/packages/query-core/src/subscribable.ts#L41) + +Returns `true` while at least one listener is registered, `false` once they have all unsubscribed. #### Returns diff --git a/docs/framework/preact/reference/classes/Mutation.md b/docs/framework/preact/reference/classes/Mutation.md index fa3b9c79522..49975b76a75 100644 --- a/docs/framework/preact/reference/classes/Mutation.md +++ b/docs/framework/preact/reference/classes/Mutation.md @@ -78,7 +78,7 @@ Removable.constructor gcTime: number; ``` -Defined in: [packages/query-core/src/removable.ts:7](https://github.com/TanStack/query/blob/main/packages/query-core/src/removable.ts#L7) +Defined in: [packages/query-core/src/removable.ts:11](https://github.com/TanStack/query/blob/main/packages/query-core/src/removable.ts#L11) #### Inherited from @@ -142,7 +142,7 @@ The `meta` object passed in the mutation's options, if any. protected clearGcTimeout(): void; ``` -Defined in: [packages/query-core/src/removable.ts:32](https://github.com/TanStack/query/blob/main/packages/query-core/src/removable.ts#L32) +Defined in: [packages/query-core/src/removable.ts:41](https://github.com/TanStack/query/blob/main/packages/query-core/src/removable.ts#L41) #### Returns @@ -199,7 +199,11 @@ await mutation?.continue() destroy(): void; ``` -Defined in: [packages/query-core/src/removable.ts:10](https://github.com/TanStack/query/blob/main/packages/query-core/src/removable.ts#L10) +Defined in: [packages/query-core/src/removable.ts:19](https://github.com/TanStack/query/blob/main/packages/query-core/src/removable.ts#L19) + +Clears the pending garbage collection timeout, so the entry is no longer scheduled for removal. +A subclass may override this to release what it holds on to as well — `Query` also cancels any +in-flight fetch. #### Returns @@ -291,7 +295,7 @@ Removable.optionalRemove protected scheduleGc(): void; ``` -Defined in: [packages/query-core/src/removable.ts:14](https://github.com/TanStack/query/blob/main/packages/query-core/src/removable.ts#L14) +Defined in: [packages/query-core/src/removable.ts:23](https://github.com/TanStack/query/blob/main/packages/query-core/src/removable.ts#L23) #### Returns @@ -311,7 +315,7 @@ Removable.scheduleGc protected updateGcTime(newGcTime: number | undefined): void; ``` -Defined in: [packages/query-core/src/removable.ts:24](https://github.com/TanStack/query/blob/main/packages/query-core/src/removable.ts#L24) +Defined in: [packages/query-core/src/removable.ts:33](https://github.com/TanStack/query/blob/main/packages/query-core/src/removable.ts#L33) #### Parameters diff --git a/docs/framework/preact/reference/classes/MutationCache.md b/docs/framework/preact/reference/classes/MutationCache.md index 65015530c74..b64b17cf0e9 100644 --- a/docs/framework/preact/reference/classes/MutationCache.md +++ b/docs/framework/preact/reference/classes/MutationCache.md @@ -67,7 +67,7 @@ Defined in: [packages/query-core/src/mutationCache.ts:129](https://github.com/Ta protected listeners: Set; ``` -Defined in: [packages/query-core/src/subscribable.ts:2](https://github.com/TanStack/query/blob/main/packages/query-core/src/subscribable.ts#L2) +Defined in: [packages/query-core/src/subscribable.ts:7](https://github.com/TanStack/query/blob/main/packages/query-core/src/subscribable.ts#L7) #### Inherited from @@ -231,7 +231,9 @@ const mutations = mutationCache.getAll() hasListeners(): boolean; ``` -Defined in: [packages/query-core/src/subscribable.ts:19](https://github.com/TanStack/query/blob/main/packages/query-core/src/subscribable.ts#L19) +Defined in: [packages/query-core/src/subscribable.ts:41](https://github.com/TanStack/query/blob/main/packages/query-core/src/subscribable.ts#L41) + +Returns `true` while at least one listener is registered, `false` once they have all unsubscribed. #### Returns @@ -251,7 +253,7 @@ Subscribable.hasListeners protected onSubscribe(): void; ``` -Defined in: [packages/query-core/src/subscribable.ts:23](https://github.com/TanStack/query/blob/main/packages/query-core/src/subscribable.ts#L23) +Defined in: [packages/query-core/src/subscribable.ts:45](https://github.com/TanStack/query/blob/main/packages/query-core/src/subscribable.ts#L45) #### Returns @@ -271,7 +273,7 @@ Subscribable.onSubscribe protected onUnsubscribe(): void; ``` -Defined in: [packages/query-core/src/subscribable.ts:27](https://github.com/TanStack/query/blob/main/packages/query-core/src/subscribable.ts#L27) +Defined in: [packages/query-core/src/subscribable.ts:49](https://github.com/TanStack/query/blob/main/packages/query-core/src/subscribable.ts#L49) #### Returns @@ -291,7 +293,11 @@ Subscribable.onUnsubscribe subscribe(listener: MutationCacheListener): () => void; ``` -Defined in: [packages/query-core/src/subscribable.ts:8](https://github.com/TanStack/query/blob/main/packages/query-core/src/subscribable.ts#L8) +Defined in: [packages/query-core/src/subscribable.ts:27](https://github.com/TanStack/query/blob/main/packages/query-core/src/subscribable.ts#L27) + +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()`. #### Parameters @@ -299,6 +305,8 @@ Defined in: [packages/query-core/src/subscribable.ts:8](https://github.com/TanSt `MutationCacheListener` +Called on each update, with whatever the subclass passes to its subscribers. + #### Returns ```ts @@ -309,6 +317,16 @@ Defined in: [packages/query-core/src/subscribable.ts:8](https://github.com/TanSt `void` +#### Example + +```ts +const unsubscribe = subscribable.subscribe(() => { + // react to the update +}) + +unsubscribe() +``` + #### Inherited from ```ts diff --git a/docs/framework/preact/reference/classes/MutationObserver.md b/docs/framework/preact/reference/classes/MutationObserver.md index 90bac0ff994..e8ba6146fb3 100644 --- a/docs/framework/preact/reference/classes/MutationObserver.md +++ b/docs/framework/preact/reference/classes/MutationObserver.md @@ -82,7 +82,7 @@ Subscribable< protected listeners: Set>; ``` -Defined in: [packages/query-core/src/subscribable.ts:2](https://github.com/TanStack/query/blob/main/packages/query-core/src/subscribable.ts#L2) +Defined in: [packages/query-core/src/subscribable.ts:7](https://github.com/TanStack/query/blob/main/packages/query-core/src/subscribable.ts#L7) #### Inherited from @@ -140,7 +140,9 @@ built yet, e.g. before the first `mutate()` call or after `reset()`). hasListeners(): boolean; ``` -Defined in: [packages/query-core/src/subscribable.ts:19](https://github.com/TanStack/query/blob/main/packages/query-core/src/subscribable.ts#L19) +Defined in: [packages/query-core/src/subscribable.ts:41](https://github.com/TanStack/query/blob/main/packages/query-core/src/subscribable.ts#L41) + +Returns `true` while at least one listener is registered, `false` once they have all unsubscribed. #### Returns @@ -310,7 +312,11 @@ observer.setOptions({ subscribe(listener: MutationObserverListener): () => void; ``` -Defined in: [packages/query-core/src/subscribable.ts:8](https://github.com/TanStack/query/blob/main/packages/query-core/src/subscribable.ts#L8) +Defined in: [packages/query-core/src/subscribable.ts:27](https://github.com/TanStack/query/blob/main/packages/query-core/src/subscribable.ts#L27) + +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()`. #### Parameters @@ -318,6 +324,8 @@ Defined in: [packages/query-core/src/subscribable.ts:8](https://github.com/TanSt `MutationObserverListener` +Called on each update, with whatever the subclass passes to its subscribers. + #### Returns ```ts @@ -328,6 +336,16 @@ Defined in: [packages/query-core/src/subscribable.ts:8](https://github.com/TanSt `void` +#### Example + +```ts +const unsubscribe = subscribable.subscribe(() => { + // react to the update +}) + +unsubscribe() +``` + #### Inherited from ```ts diff --git a/docs/framework/preact/reference/classes/QueriesObserver.md b/docs/framework/preact/reference/classes/QueriesObserver.md index 8bf48fdbebe..ebcbcd9cc97 100644 --- a/docs/framework/preact/reference/classes/QueriesObserver.md +++ b/docs/framework/preact/reference/classes/QueriesObserver.md @@ -79,7 +79,7 @@ Subscribable.constructor protected listeners: Set; ``` -Defined in: [packages/query-core/src/subscribable.ts:2](https://github.com/TanStack/query/blob/main/packages/query-core/src/subscribable.ts#L2) +Defined in: [packages/query-core/src/subscribable.ts:7](https://github.com/TanStack/query/blob/main/packages/query-core/src/subscribable.ts#L7) #### Inherited from @@ -202,7 +202,9 @@ the same order as the queries passed to the constructor or `setQueries`. hasListeners(): boolean; ``` -Defined in: [packages/query-core/src/subscribable.ts:19](https://github.com/TanStack/query/blob/main/packages/query-core/src/subscribable.ts#L19) +Defined in: [packages/query-core/src/subscribable.ts:41](https://github.com/TanStack/query/blob/main/packages/query-core/src/subscribable.ts#L41) + +Returns `true` while at least one listener is registered, `false` once they have all unsubscribed. #### Returns @@ -300,7 +302,11 @@ observer.setQueries([ subscribe(listener: QueriesObserverListener): () => void; ``` -Defined in: [packages/query-core/src/subscribable.ts:8](https://github.com/TanStack/query/blob/main/packages/query-core/src/subscribable.ts#L8) +Defined in: [packages/query-core/src/subscribable.ts:27](https://github.com/TanStack/query/blob/main/packages/query-core/src/subscribable.ts#L27) + +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()`. #### Parameters @@ -308,6 +314,8 @@ Defined in: [packages/query-core/src/subscribable.ts:8](https://github.com/TanSt `QueriesObserverListener` +Called on each update, with whatever the subclass passes to its subscribers. + #### Returns ```ts @@ -318,6 +326,16 @@ Defined in: [packages/query-core/src/subscribable.ts:8](https://github.com/TanSt `void` +#### Example + +```ts +const unsubscribe = subscribable.subscribe(() => { + // react to the update +}) + +unsubscribe() +``` + #### Inherited from ```ts diff --git a/docs/framework/preact/reference/classes/Query.md b/docs/framework/preact/reference/classes/Query.md index fee2fb07529..646028952e1 100644 --- a/docs/framework/preact/reference/classes/Query.md +++ b/docs/framework/preact/reference/classes/Query.md @@ -80,7 +80,7 @@ Removable.constructor gcTime: number; ``` -Defined in: [packages/query-core/src/removable.ts:7](https://github.com/TanStack/query/blob/main/packages/query-core/src/removable.ts#L7) +Defined in: [packages/query-core/src/removable.ts:11](https://github.com/TanStack/query/blob/main/packages/query-core/src/removable.ts#L11) #### Inherited from @@ -213,7 +213,7 @@ await query.cancel() protected clearGcTimeout(): void; ``` -Defined in: [packages/query-core/src/removable.ts:32](https://github.com/TanStack/query/blob/main/packages/query-core/src/removable.ts#L32) +Defined in: [packages/query-core/src/removable.ts:41](https://github.com/TanStack/query/blob/main/packages/query-core/src/removable.ts#L41) #### Returns @@ -522,7 +522,7 @@ in-flight fetch. protected scheduleGc(): void; ``` -Defined in: [packages/query-core/src/removable.ts:14](https://github.com/TanStack/query/blob/main/packages/query-core/src/removable.ts#L14) +Defined in: [packages/query-core/src/removable.ts:23](https://github.com/TanStack/query/blob/main/packages/query-core/src/removable.ts#L23) #### Returns @@ -566,7 +566,7 @@ user manually trigger a loading/error state or edit the cached data. protected updateGcTime(newGcTime: number | undefined): void; ``` -Defined in: [packages/query-core/src/removable.ts:24](https://github.com/TanStack/query/blob/main/packages/query-core/src/removable.ts#L24) +Defined in: [packages/query-core/src/removable.ts:33](https://github.com/TanStack/query/blob/main/packages/query-core/src/removable.ts#L33) #### Parameters diff --git a/docs/framework/preact/reference/classes/QueryCache.md b/docs/framework/preact/reference/classes/QueryCache.md index 982a6e72fb9..18520030db7 100644 --- a/docs/framework/preact/reference/classes/QueryCache.md +++ b/docs/framework/preact/reference/classes/QueryCache.md @@ -70,7 +70,7 @@ Defined in: [packages/query-core/src/queryCache.ts:126](https://github.com/TanSt protected listeners: Set; ``` -Defined in: [packages/query-core/src/subscribable.ts:2](https://github.com/TanStack/query/blob/main/packages/query-core/src/subscribable.ts#L2) +Defined in: [packages/query-core/src/subscribable.ts:7](https://github.com/TanStack/query/blob/main/packages/query-core/src/subscribable.ts#L7) #### Inherited from @@ -350,7 +350,9 @@ const queries = queryCache.getAll() hasListeners(): boolean; ``` -Defined in: [packages/query-core/src/subscribable.ts:19](https://github.com/TanStack/query/blob/main/packages/query-core/src/subscribable.ts#L19) +Defined in: [packages/query-core/src/subscribable.ts:41](https://github.com/TanStack/query/blob/main/packages/query-core/src/subscribable.ts#L41) + +Returns `true` while at least one listener is registered, `false` once they have all unsubscribed. #### Returns @@ -370,7 +372,7 @@ Subscribable.hasListeners protected onSubscribe(): void; ``` -Defined in: [packages/query-core/src/subscribable.ts:23](https://github.com/TanStack/query/blob/main/packages/query-core/src/subscribable.ts#L23) +Defined in: [packages/query-core/src/subscribable.ts:45](https://github.com/TanStack/query/blob/main/packages/query-core/src/subscribable.ts#L45) #### Returns @@ -390,7 +392,7 @@ Subscribable.onSubscribe protected onUnsubscribe(): void; ``` -Defined in: [packages/query-core/src/subscribable.ts:27](https://github.com/TanStack/query/blob/main/packages/query-core/src/subscribable.ts#L27) +Defined in: [packages/query-core/src/subscribable.ts:49](https://github.com/TanStack/query/blob/main/packages/query-core/src/subscribable.ts#L49) #### Returns @@ -446,7 +448,11 @@ if (query) { subscribe(listener: QueryCacheListener): () => void; ``` -Defined in: [packages/query-core/src/subscribable.ts:8](https://github.com/TanStack/query/blob/main/packages/query-core/src/subscribable.ts#L8) +Defined in: [packages/query-core/src/subscribable.ts:27](https://github.com/TanStack/query/blob/main/packages/query-core/src/subscribable.ts#L27) + +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()`. #### Parameters @@ -454,6 +460,8 @@ Defined in: [packages/query-core/src/subscribable.ts:8](https://github.com/TanSt `QueryCacheListener` +Called on each update, with whatever the subclass passes to its subscribers. + #### Returns ```ts @@ -464,6 +472,16 @@ Defined in: [packages/query-core/src/subscribable.ts:8](https://github.com/TanSt `void` +#### Example + +```ts +const unsubscribe = subscribable.subscribe(() => { + // react to the update +}) + +unsubscribe() +``` + #### Inherited from ```ts diff --git a/docs/framework/preact/reference/classes/QueryObserver.md b/docs/framework/preact/reference/classes/QueryObserver.md index 8f5dd48169e..ba20c873925 100644 --- a/docs/framework/preact/reference/classes/QueryObserver.md +++ b/docs/framework/preact/reference/classes/QueryObserver.md @@ -93,7 +93,7 @@ Subscribable>.constructor protected listeners: Set>; ``` -Defined in: [packages/query-core/src/subscribable.ts:2](https://github.com/TanStack/query/blob/main/packages/query-core/src/subscribable.ts#L2) +Defined in: [packages/query-core/src/subscribable.ts:7](https://github.com/TanStack/query/blob/main/packages/query-core/src/subscribable.ts#L7) #### Inherited from @@ -298,7 +298,9 @@ returned value is available synchronously, ahead of `setOptions` triggering an a hasListeners(): boolean; ``` -Defined in: [packages/query-core/src/subscribable.ts:19](https://github.com/TanStack/query/blob/main/packages/query-core/src/subscribable.ts#L19) +Defined in: [packages/query-core/src/subscribable.ts:41](https://github.com/TanStack/query/blob/main/packages/query-core/src/subscribable.ts#L41) + +Returns `true` while at least one listener is registered, `false` once they have all unsubscribed. #### Returns @@ -458,7 +460,11 @@ regains focus. subscribe(listener: QueryObserverListener): () => void; ``` -Defined in: [packages/query-core/src/subscribable.ts:8](https://github.com/TanStack/query/blob/main/packages/query-core/src/subscribable.ts#L8) +Defined in: [packages/query-core/src/subscribable.ts:27](https://github.com/TanStack/query/blob/main/packages/query-core/src/subscribable.ts#L27) + +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()`. #### Parameters @@ -466,6 +472,8 @@ Defined in: [packages/query-core/src/subscribable.ts:8](https://github.com/TanSt `QueryObserverListener` +Called on each update, with whatever the subclass passes to its subscribers. + #### Returns ```ts @@ -476,6 +484,16 @@ Defined in: [packages/query-core/src/subscribable.ts:8](https://github.com/TanSt `void` +#### Example + +```ts +const unsubscribe = subscribable.subscribe(() => { + // react to the update +}) + +unsubscribe() +``` + #### Inherited from ```ts diff --git a/docs/framework/preact/reference/interfaces/FocusManager.md b/docs/framework/preact/reference/interfaces/FocusManager.md index 63e0813388a..c0e6c1dcf22 100644 --- a/docs/framework/preact/reference/interfaces/FocusManager.md +++ b/docs/framework/preact/reference/interfaces/FocusManager.md @@ -27,7 +27,9 @@ It can be used to change the default event listeners or to manually change the f hasListeners(): boolean; ``` -Defined in: [packages/query-core/src/subscribable.ts:19](https://github.com/TanStack/query/blob/main/packages/query-core/src/subscribable.ts#L19) +Defined in: [packages/query-core/src/subscribable.ts:41](https://github.com/TanStack/query/blob/main/packages/query-core/src/subscribable.ts#L41) + +Returns `true` while at least one listener is registered, `false` once they have all unsubscribed. #### Returns @@ -202,7 +204,11 @@ focusManager.setFocused(undefined) subscribe(listener: Listener): () => void; ``` -Defined in: [packages/query-core/src/subscribable.ts:8](https://github.com/TanStack/query/blob/main/packages/query-core/src/subscribable.ts#L8) +Defined in: [packages/query-core/src/subscribable.ts:27](https://github.com/TanStack/query/blob/main/packages/query-core/src/subscribable.ts#L27) + +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()`. #### Parameters @@ -210,6 +216,8 @@ Defined in: [packages/query-core/src/subscribable.ts:8](https://github.com/TanSt `Listener` +Called on each update, with whatever the subclass passes to its subscribers. + #### Returns ```ts @@ -220,6 +228,16 @@ Defined in: [packages/query-core/src/subscribable.ts:8](https://github.com/TanSt `void` +#### Example + +```ts +const unsubscribe = subscribable.subscribe(() => { + // react to the update +}) + +unsubscribe() +``` + #### Inherited from ```ts diff --git a/docs/framework/preact/reference/interfaces/OnlineManager.md b/docs/framework/preact/reference/interfaces/OnlineManager.md index 6f0f71074db..e9f911fce4e 100644 --- a/docs/framework/preact/reference/interfaces/OnlineManager.md +++ b/docs/framework/preact/reference/interfaces/OnlineManager.md @@ -31,7 +31,9 @@ detect changes. hasListeners(): boolean; ``` -Defined in: [packages/query-core/src/subscribable.ts:19](https://github.com/TanStack/query/blob/main/packages/query-core/src/subscribable.ts#L19) +Defined in: [packages/query-core/src/subscribable.ts:41](https://github.com/TanStack/query/blob/main/packages/query-core/src/subscribable.ts#L41) + +Returns `true` while at least one listener is registered, `false` once they have all unsubscribed. #### Returns @@ -179,7 +181,11 @@ onlineManager.setOnline(false) subscribe(listener: Listener): () => void; ``` -Defined in: [packages/query-core/src/subscribable.ts:8](https://github.com/TanStack/query/blob/main/packages/query-core/src/subscribable.ts#L8) +Defined in: [packages/query-core/src/subscribable.ts:27](https://github.com/TanStack/query/blob/main/packages/query-core/src/subscribable.ts#L27) + +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()`. #### Parameters @@ -187,6 +193,8 @@ Defined in: [packages/query-core/src/subscribable.ts:8](https://github.com/TanSt `Listener` +Called on each update, with whatever the subclass passes to its subscribers. + #### Returns ```ts @@ -197,6 +205,16 @@ Defined in: [packages/query-core/src/subscribable.ts:8](https://github.com/TanSt `void` +#### Example + +```ts +const unsubscribe = subscribable.subscribe(() => { + // react to the update +}) + +unsubscribe() +``` + #### Inherited from ```ts diff --git a/docs/framework/react/reference/classes/InfiniteQueryObserver.md b/docs/framework/react/reference/classes/InfiniteQueryObserver.md index 84a44027ee5..c9360dc77f1 100644 --- a/docs/framework/react/reference/classes/InfiniteQueryObserver.md +++ b/docs/framework/react/reference/classes/InfiniteQueryObserver.md @@ -133,7 +133,7 @@ QueryObserver.getCurrentResult protected listeners: Set>; ``` -Defined in: [packages/query-core/src/subscribable.ts:2](https://github.com/TanStack/query/blob/main/packages/query-core/src/subscribable.ts#L2) +Defined in: [packages/query-core/src/subscribable.ts:7](https://github.com/TanStack/query/blob/main/packages/query-core/src/subscribable.ts#L7) #### Inherited from @@ -163,12 +163,18 @@ subscribe: (listener: InfiniteQueryObserverListener) => () => void; Defined in: [packages/query-core/src/infiniteQueryObserver.ts:55](https://github.com/TanStack/query/blob/main/packages/query-core/src/infiniteQueryObserver.ts#L55) +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()`. + #### Parameters ##### listener `InfiniteQueryObserverListener` +Called on each update, with whatever the subclass passes to its subscribers. + #### Returns ```ts @@ -179,6 +185,16 @@ Defined in: [packages/query-core/src/infiniteQueryObserver.ts:55](https://github `void` +#### Example + +```ts +const unsubscribe = subscribable.subscribe(() => { + // react to the update +}) + +unsubscribe() +``` + #### Overrides ```ts @@ -430,7 +446,9 @@ synchronously. hasListeners(): boolean; ``` -Defined in: [packages/query-core/src/subscribable.ts:19](https://github.com/TanStack/query/blob/main/packages/query-core/src/subscribable.ts#L19) +Defined in: [packages/query-core/src/subscribable.ts:41](https://github.com/TanStack/query/blob/main/packages/query-core/src/subscribable.ts#L41) + +Returns `true` while at least one listener is registered, `false` once they have all unsubscribed. #### Returns diff --git a/docs/framework/react/reference/classes/Mutation.md b/docs/framework/react/reference/classes/Mutation.md index fa3b9c79522..49975b76a75 100644 --- a/docs/framework/react/reference/classes/Mutation.md +++ b/docs/framework/react/reference/classes/Mutation.md @@ -78,7 +78,7 @@ Removable.constructor gcTime: number; ``` -Defined in: [packages/query-core/src/removable.ts:7](https://github.com/TanStack/query/blob/main/packages/query-core/src/removable.ts#L7) +Defined in: [packages/query-core/src/removable.ts:11](https://github.com/TanStack/query/blob/main/packages/query-core/src/removable.ts#L11) #### Inherited from @@ -142,7 +142,7 @@ The `meta` object passed in the mutation's options, if any. protected clearGcTimeout(): void; ``` -Defined in: [packages/query-core/src/removable.ts:32](https://github.com/TanStack/query/blob/main/packages/query-core/src/removable.ts#L32) +Defined in: [packages/query-core/src/removable.ts:41](https://github.com/TanStack/query/blob/main/packages/query-core/src/removable.ts#L41) #### Returns @@ -199,7 +199,11 @@ await mutation?.continue() destroy(): void; ``` -Defined in: [packages/query-core/src/removable.ts:10](https://github.com/TanStack/query/blob/main/packages/query-core/src/removable.ts#L10) +Defined in: [packages/query-core/src/removable.ts:19](https://github.com/TanStack/query/blob/main/packages/query-core/src/removable.ts#L19) + +Clears the pending garbage collection timeout, so the entry is no longer scheduled for removal. +A subclass may override this to release what it holds on to as well — `Query` also cancels any +in-flight fetch. #### Returns @@ -291,7 +295,7 @@ Removable.optionalRemove protected scheduleGc(): void; ``` -Defined in: [packages/query-core/src/removable.ts:14](https://github.com/TanStack/query/blob/main/packages/query-core/src/removable.ts#L14) +Defined in: [packages/query-core/src/removable.ts:23](https://github.com/TanStack/query/blob/main/packages/query-core/src/removable.ts#L23) #### Returns @@ -311,7 +315,7 @@ Removable.scheduleGc protected updateGcTime(newGcTime: number | undefined): void; ``` -Defined in: [packages/query-core/src/removable.ts:24](https://github.com/TanStack/query/blob/main/packages/query-core/src/removable.ts#L24) +Defined in: [packages/query-core/src/removable.ts:33](https://github.com/TanStack/query/blob/main/packages/query-core/src/removable.ts#L33) #### Parameters diff --git a/docs/framework/react/reference/classes/MutationCache.md b/docs/framework/react/reference/classes/MutationCache.md index f5643fb5fe1..dd440d15c63 100644 --- a/docs/framework/react/reference/classes/MutationCache.md +++ b/docs/framework/react/reference/classes/MutationCache.md @@ -70,7 +70,7 @@ Defined in: [packages/query-core/src/mutationCache.ts:129](https://github.com/Ta protected listeners: Set; ``` -Defined in: [packages/query-core/src/subscribable.ts:2](https://github.com/TanStack/query/blob/main/packages/query-core/src/subscribable.ts#L2) +Defined in: [packages/query-core/src/subscribable.ts:7](https://github.com/TanStack/query/blob/main/packages/query-core/src/subscribable.ts#L7) #### Inherited from @@ -234,7 +234,9 @@ const mutations = mutationCache.getAll() hasListeners(): boolean; ``` -Defined in: [packages/query-core/src/subscribable.ts:19](https://github.com/TanStack/query/blob/main/packages/query-core/src/subscribable.ts#L19) +Defined in: [packages/query-core/src/subscribable.ts:41](https://github.com/TanStack/query/blob/main/packages/query-core/src/subscribable.ts#L41) + +Returns `true` while at least one listener is registered, `false` once they have all unsubscribed. #### Returns @@ -254,7 +256,7 @@ Subscribable.hasListeners protected onSubscribe(): void; ``` -Defined in: [packages/query-core/src/subscribable.ts:23](https://github.com/TanStack/query/blob/main/packages/query-core/src/subscribable.ts#L23) +Defined in: [packages/query-core/src/subscribable.ts:45](https://github.com/TanStack/query/blob/main/packages/query-core/src/subscribable.ts#L45) #### Returns @@ -274,7 +276,7 @@ Subscribable.onSubscribe protected onUnsubscribe(): void; ``` -Defined in: [packages/query-core/src/subscribable.ts:27](https://github.com/TanStack/query/blob/main/packages/query-core/src/subscribable.ts#L27) +Defined in: [packages/query-core/src/subscribable.ts:49](https://github.com/TanStack/query/blob/main/packages/query-core/src/subscribable.ts#L49) #### Returns @@ -294,7 +296,11 @@ Subscribable.onUnsubscribe subscribe(listener: MutationCacheListener): () => void; ``` -Defined in: [packages/query-core/src/subscribable.ts:8](https://github.com/TanStack/query/blob/main/packages/query-core/src/subscribable.ts#L8) +Defined in: [packages/query-core/src/subscribable.ts:27](https://github.com/TanStack/query/blob/main/packages/query-core/src/subscribable.ts#L27) + +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()`. #### Parameters @@ -302,6 +308,8 @@ Defined in: [packages/query-core/src/subscribable.ts:8](https://github.com/TanSt `MutationCacheListener` +Called on each update, with whatever the subclass passes to its subscribers. + #### Returns ```ts @@ -312,6 +320,16 @@ Defined in: [packages/query-core/src/subscribable.ts:8](https://github.com/TanSt `void` +#### Example + +```ts +const unsubscribe = subscribable.subscribe(() => { + // react to the update +}) + +unsubscribe() +``` + #### Inherited from ```ts diff --git a/docs/framework/react/reference/classes/MutationObserver.md b/docs/framework/react/reference/classes/MutationObserver.md index 90bac0ff994..e8ba6146fb3 100644 --- a/docs/framework/react/reference/classes/MutationObserver.md +++ b/docs/framework/react/reference/classes/MutationObserver.md @@ -82,7 +82,7 @@ Subscribable< protected listeners: Set>; ``` -Defined in: [packages/query-core/src/subscribable.ts:2](https://github.com/TanStack/query/blob/main/packages/query-core/src/subscribable.ts#L2) +Defined in: [packages/query-core/src/subscribable.ts:7](https://github.com/TanStack/query/blob/main/packages/query-core/src/subscribable.ts#L7) #### Inherited from @@ -140,7 +140,9 @@ built yet, e.g. before the first `mutate()` call or after `reset()`). hasListeners(): boolean; ``` -Defined in: [packages/query-core/src/subscribable.ts:19](https://github.com/TanStack/query/blob/main/packages/query-core/src/subscribable.ts#L19) +Defined in: [packages/query-core/src/subscribable.ts:41](https://github.com/TanStack/query/blob/main/packages/query-core/src/subscribable.ts#L41) + +Returns `true` while at least one listener is registered, `false` once they have all unsubscribed. #### Returns @@ -310,7 +312,11 @@ observer.setOptions({ subscribe(listener: MutationObserverListener): () => void; ``` -Defined in: [packages/query-core/src/subscribable.ts:8](https://github.com/TanStack/query/blob/main/packages/query-core/src/subscribable.ts#L8) +Defined in: [packages/query-core/src/subscribable.ts:27](https://github.com/TanStack/query/blob/main/packages/query-core/src/subscribable.ts#L27) + +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()`. #### Parameters @@ -318,6 +324,8 @@ Defined in: [packages/query-core/src/subscribable.ts:8](https://github.com/TanSt `MutationObserverListener` +Called on each update, with whatever the subclass passes to its subscribers. + #### Returns ```ts @@ -328,6 +336,16 @@ Defined in: [packages/query-core/src/subscribable.ts:8](https://github.com/TanSt `void` +#### Example + +```ts +const unsubscribe = subscribable.subscribe(() => { + // react to the update +}) + +unsubscribe() +``` + #### Inherited from ```ts diff --git a/docs/framework/react/reference/classes/QueriesObserver.md b/docs/framework/react/reference/classes/QueriesObserver.md index 0bfdcccbf00..6ffa32853ac 100644 --- a/docs/framework/react/reference/classes/QueriesObserver.md +++ b/docs/framework/react/reference/classes/QueriesObserver.md @@ -82,7 +82,7 @@ Subscribable.constructor protected listeners: Set; ``` -Defined in: [packages/query-core/src/subscribable.ts:2](https://github.com/TanStack/query/blob/main/packages/query-core/src/subscribable.ts#L2) +Defined in: [packages/query-core/src/subscribable.ts:7](https://github.com/TanStack/query/blob/main/packages/query-core/src/subscribable.ts#L7) #### Inherited from @@ -205,7 +205,9 @@ the same order as the queries passed to the constructor or `setQueries`. hasListeners(): boolean; ``` -Defined in: [packages/query-core/src/subscribable.ts:19](https://github.com/TanStack/query/blob/main/packages/query-core/src/subscribable.ts#L19) +Defined in: [packages/query-core/src/subscribable.ts:41](https://github.com/TanStack/query/blob/main/packages/query-core/src/subscribable.ts#L41) + +Returns `true` while at least one listener is registered, `false` once they have all unsubscribed. #### Returns @@ -303,7 +305,11 @@ observer.setQueries([ subscribe(listener: QueriesObserverListener): () => void; ``` -Defined in: [packages/query-core/src/subscribable.ts:8](https://github.com/TanStack/query/blob/main/packages/query-core/src/subscribable.ts#L8) +Defined in: [packages/query-core/src/subscribable.ts:27](https://github.com/TanStack/query/blob/main/packages/query-core/src/subscribable.ts#L27) + +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()`. #### Parameters @@ -311,6 +317,8 @@ Defined in: [packages/query-core/src/subscribable.ts:8](https://github.com/TanSt `QueriesObserverListener` +Called on each update, with whatever the subclass passes to its subscribers. + #### Returns ```ts @@ -321,6 +329,16 @@ Defined in: [packages/query-core/src/subscribable.ts:8](https://github.com/TanSt `void` +#### Example + +```ts +const unsubscribe = subscribable.subscribe(() => { + // react to the update +}) + +unsubscribe() +``` + #### Inherited from ```ts diff --git a/docs/framework/react/reference/classes/Query.md b/docs/framework/react/reference/classes/Query.md index fee2fb07529..646028952e1 100644 --- a/docs/framework/react/reference/classes/Query.md +++ b/docs/framework/react/reference/classes/Query.md @@ -80,7 +80,7 @@ Removable.constructor gcTime: number; ``` -Defined in: [packages/query-core/src/removable.ts:7](https://github.com/TanStack/query/blob/main/packages/query-core/src/removable.ts#L7) +Defined in: [packages/query-core/src/removable.ts:11](https://github.com/TanStack/query/blob/main/packages/query-core/src/removable.ts#L11) #### Inherited from @@ -213,7 +213,7 @@ await query.cancel() protected clearGcTimeout(): void; ``` -Defined in: [packages/query-core/src/removable.ts:32](https://github.com/TanStack/query/blob/main/packages/query-core/src/removable.ts#L32) +Defined in: [packages/query-core/src/removable.ts:41](https://github.com/TanStack/query/blob/main/packages/query-core/src/removable.ts#L41) #### Returns @@ -522,7 +522,7 @@ in-flight fetch. protected scheduleGc(): void; ``` -Defined in: [packages/query-core/src/removable.ts:14](https://github.com/TanStack/query/blob/main/packages/query-core/src/removable.ts#L14) +Defined in: [packages/query-core/src/removable.ts:23](https://github.com/TanStack/query/blob/main/packages/query-core/src/removable.ts#L23) #### Returns @@ -566,7 +566,7 @@ user manually trigger a loading/error state or edit the cached data. protected updateGcTime(newGcTime: number | undefined): void; ``` -Defined in: [packages/query-core/src/removable.ts:24](https://github.com/TanStack/query/blob/main/packages/query-core/src/removable.ts#L24) +Defined in: [packages/query-core/src/removable.ts:33](https://github.com/TanStack/query/blob/main/packages/query-core/src/removable.ts#L33) #### Parameters diff --git a/docs/framework/react/reference/classes/QueryCache.md b/docs/framework/react/reference/classes/QueryCache.md index 749af9a1bca..17a1a23a01f 100644 --- a/docs/framework/react/reference/classes/QueryCache.md +++ b/docs/framework/react/reference/classes/QueryCache.md @@ -73,7 +73,7 @@ Defined in: [packages/query-core/src/queryCache.ts:126](https://github.com/TanSt protected listeners: Set; ``` -Defined in: [packages/query-core/src/subscribable.ts:2](https://github.com/TanStack/query/blob/main/packages/query-core/src/subscribable.ts#L2) +Defined in: [packages/query-core/src/subscribable.ts:7](https://github.com/TanStack/query/blob/main/packages/query-core/src/subscribable.ts#L7) #### Inherited from @@ -353,7 +353,9 @@ const queries = queryCache.getAll() hasListeners(): boolean; ``` -Defined in: [packages/query-core/src/subscribable.ts:19](https://github.com/TanStack/query/blob/main/packages/query-core/src/subscribable.ts#L19) +Defined in: [packages/query-core/src/subscribable.ts:41](https://github.com/TanStack/query/blob/main/packages/query-core/src/subscribable.ts#L41) + +Returns `true` while at least one listener is registered, `false` once they have all unsubscribed. #### Returns @@ -373,7 +375,7 @@ Subscribable.hasListeners protected onSubscribe(): void; ``` -Defined in: [packages/query-core/src/subscribable.ts:23](https://github.com/TanStack/query/blob/main/packages/query-core/src/subscribable.ts#L23) +Defined in: [packages/query-core/src/subscribable.ts:45](https://github.com/TanStack/query/blob/main/packages/query-core/src/subscribable.ts#L45) #### Returns @@ -393,7 +395,7 @@ Subscribable.onSubscribe protected onUnsubscribe(): void; ``` -Defined in: [packages/query-core/src/subscribable.ts:27](https://github.com/TanStack/query/blob/main/packages/query-core/src/subscribable.ts#L27) +Defined in: [packages/query-core/src/subscribable.ts:49](https://github.com/TanStack/query/blob/main/packages/query-core/src/subscribable.ts#L49) #### Returns @@ -449,7 +451,11 @@ if (query) { subscribe(listener: QueryCacheListener): () => void; ``` -Defined in: [packages/query-core/src/subscribable.ts:8](https://github.com/TanStack/query/blob/main/packages/query-core/src/subscribable.ts#L8) +Defined in: [packages/query-core/src/subscribable.ts:27](https://github.com/TanStack/query/blob/main/packages/query-core/src/subscribable.ts#L27) + +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()`. #### Parameters @@ -457,6 +463,8 @@ Defined in: [packages/query-core/src/subscribable.ts:8](https://github.com/TanSt `QueryCacheListener` +Called on each update, with whatever the subclass passes to its subscribers. + #### Returns ```ts @@ -467,6 +475,16 @@ Defined in: [packages/query-core/src/subscribable.ts:8](https://github.com/TanSt `void` +#### Example + +```ts +const unsubscribe = subscribable.subscribe(() => { + // react to the update +}) + +unsubscribe() +``` + #### Inherited from ```ts diff --git a/docs/framework/react/reference/classes/QueryObserver.md b/docs/framework/react/reference/classes/QueryObserver.md index bafb738ee20..c53eb127be8 100644 --- a/docs/framework/react/reference/classes/QueryObserver.md +++ b/docs/framework/react/reference/classes/QueryObserver.md @@ -96,7 +96,7 @@ Subscribable>.constructor protected listeners: Set>; ``` -Defined in: [packages/query-core/src/subscribable.ts:2](https://github.com/TanStack/query/blob/main/packages/query-core/src/subscribable.ts#L2) +Defined in: [packages/query-core/src/subscribable.ts:7](https://github.com/TanStack/query/blob/main/packages/query-core/src/subscribable.ts#L7) #### Inherited from @@ -301,7 +301,9 @@ returned value is available synchronously, ahead of `setOptions` triggering an a hasListeners(): boolean; ``` -Defined in: [packages/query-core/src/subscribable.ts:19](https://github.com/TanStack/query/blob/main/packages/query-core/src/subscribable.ts#L19) +Defined in: [packages/query-core/src/subscribable.ts:41](https://github.com/TanStack/query/blob/main/packages/query-core/src/subscribable.ts#L41) + +Returns `true` while at least one listener is registered, `false` once they have all unsubscribed. #### Returns @@ -461,7 +463,11 @@ regains focus. subscribe(listener: QueryObserverListener): () => void; ``` -Defined in: [packages/query-core/src/subscribable.ts:8](https://github.com/TanStack/query/blob/main/packages/query-core/src/subscribable.ts#L8) +Defined in: [packages/query-core/src/subscribable.ts:27](https://github.com/TanStack/query/blob/main/packages/query-core/src/subscribable.ts#L27) + +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()`. #### Parameters @@ -469,6 +475,8 @@ Defined in: [packages/query-core/src/subscribable.ts:8](https://github.com/TanSt `QueryObserverListener` +Called on each update, with whatever the subclass passes to its subscribers. + #### Returns ```ts @@ -479,6 +487,16 @@ Defined in: [packages/query-core/src/subscribable.ts:8](https://github.com/TanSt `void` +#### Example + +```ts +const unsubscribe = subscribable.subscribe(() => { + // react to the update +}) + +unsubscribe() +``` + #### Inherited from ```ts diff --git a/docs/framework/react/reference/interfaces/FocusManager.md b/docs/framework/react/reference/interfaces/FocusManager.md index a4905c66cb3..5cb4d734a07 100644 --- a/docs/framework/react/reference/interfaces/FocusManager.md +++ b/docs/framework/react/reference/interfaces/FocusManager.md @@ -30,7 +30,9 @@ It can be used to change the default event listeners or to manually change the f hasListeners(): boolean; ``` -Defined in: [packages/query-core/src/subscribable.ts:19](https://github.com/TanStack/query/blob/main/packages/query-core/src/subscribable.ts#L19) +Defined in: [packages/query-core/src/subscribable.ts:41](https://github.com/TanStack/query/blob/main/packages/query-core/src/subscribable.ts#L41) + +Returns `true` while at least one listener is registered, `false` once they have all unsubscribed. #### Returns @@ -205,7 +207,11 @@ focusManager.setFocused(undefined) subscribe(listener: Listener): () => void; ``` -Defined in: [packages/query-core/src/subscribable.ts:8](https://github.com/TanStack/query/blob/main/packages/query-core/src/subscribable.ts#L8) +Defined in: [packages/query-core/src/subscribable.ts:27](https://github.com/TanStack/query/blob/main/packages/query-core/src/subscribable.ts#L27) + +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()`. #### Parameters @@ -213,6 +219,8 @@ Defined in: [packages/query-core/src/subscribable.ts:8](https://github.com/TanSt `Listener` +Called on each update, with whatever the subclass passes to its subscribers. + #### Returns ```ts @@ -223,6 +231,16 @@ Defined in: [packages/query-core/src/subscribable.ts:8](https://github.com/TanSt `void` +#### Example + +```ts +const unsubscribe = subscribable.subscribe(() => { + // react to the update +}) + +unsubscribe() +``` + #### Inherited from ```ts diff --git a/docs/framework/react/reference/interfaces/OnlineManager.md b/docs/framework/react/reference/interfaces/OnlineManager.md index 9bba37298ff..e98ce5807be 100644 --- a/docs/framework/react/reference/interfaces/OnlineManager.md +++ b/docs/framework/react/reference/interfaces/OnlineManager.md @@ -34,7 +34,9 @@ detect changes. hasListeners(): boolean; ``` -Defined in: [packages/query-core/src/subscribable.ts:19](https://github.com/TanStack/query/blob/main/packages/query-core/src/subscribable.ts#L19) +Defined in: [packages/query-core/src/subscribable.ts:41](https://github.com/TanStack/query/blob/main/packages/query-core/src/subscribable.ts#L41) + +Returns `true` while at least one listener is registered, `false` once they have all unsubscribed. #### Returns @@ -182,7 +184,11 @@ onlineManager.setOnline(false) subscribe(listener: Listener): () => void; ``` -Defined in: [packages/query-core/src/subscribable.ts:8](https://github.com/TanStack/query/blob/main/packages/query-core/src/subscribable.ts#L8) +Defined in: [packages/query-core/src/subscribable.ts:27](https://github.com/TanStack/query/blob/main/packages/query-core/src/subscribable.ts#L27) + +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()`. #### Parameters @@ -190,6 +196,8 @@ Defined in: [packages/query-core/src/subscribable.ts:8](https://github.com/TanSt `Listener` +Called on each update, with whatever the subclass passes to its subscribers. + #### Returns ```ts @@ -200,6 +208,16 @@ Defined in: [packages/query-core/src/subscribable.ts:8](https://github.com/TanSt `void` +#### Example + +```ts +const unsubscribe = subscribable.subscribe(() => { + // react to the update +}) + +unsubscribe() +``` + #### Inherited from ```ts diff --git a/docs/framework/solid/reference/classes/InfiniteQueryObserver.md b/docs/framework/solid/reference/classes/InfiniteQueryObserver.md index 836e3d52947..67b5d51aed1 100644 --- a/docs/framework/solid/reference/classes/InfiniteQueryObserver.md +++ b/docs/framework/solid/reference/classes/InfiniteQueryObserver.md @@ -130,7 +130,7 @@ QueryObserver.getCurrentResult protected listeners: Set>; ``` -Defined in: [packages/query-core/src/subscribable.ts:2](https://github.com/TanStack/query/blob/main/packages/query-core/src/subscribable.ts#L2) +Defined in: [packages/query-core/src/subscribable.ts:7](https://github.com/TanStack/query/blob/main/packages/query-core/src/subscribable.ts#L7) #### Inherited from @@ -160,12 +160,18 @@ subscribe: (listener: InfiniteQueryObserverListener) => () => void; Defined in: [packages/query-core/src/infiniteQueryObserver.ts:55](https://github.com/TanStack/query/blob/main/packages/query-core/src/infiniteQueryObserver.ts#L55) +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()`. + #### Parameters ##### listener `InfiniteQueryObserverListener` +Called on each update, with whatever the subclass passes to its subscribers. + #### Returns ```ts @@ -176,6 +182,16 @@ Defined in: [packages/query-core/src/infiniteQueryObserver.ts:55](https://github `void` +#### Example + +```ts +const unsubscribe = subscribable.subscribe(() => { + // react to the update +}) + +unsubscribe() +``` + #### Overrides ```ts @@ -427,7 +443,9 @@ synchronously. hasListeners(): boolean; ``` -Defined in: [packages/query-core/src/subscribable.ts:19](https://github.com/TanStack/query/blob/main/packages/query-core/src/subscribable.ts#L19) +Defined in: [packages/query-core/src/subscribable.ts:41](https://github.com/TanStack/query/blob/main/packages/query-core/src/subscribable.ts#L41) + +Returns `true` while at least one listener is registered, `false` once they have all unsubscribed. #### Returns diff --git a/docs/framework/solid/reference/classes/Mutation.md b/docs/framework/solid/reference/classes/Mutation.md index fa3b9c79522..49975b76a75 100644 --- a/docs/framework/solid/reference/classes/Mutation.md +++ b/docs/framework/solid/reference/classes/Mutation.md @@ -78,7 +78,7 @@ Removable.constructor gcTime: number; ``` -Defined in: [packages/query-core/src/removable.ts:7](https://github.com/TanStack/query/blob/main/packages/query-core/src/removable.ts#L7) +Defined in: [packages/query-core/src/removable.ts:11](https://github.com/TanStack/query/blob/main/packages/query-core/src/removable.ts#L11) #### Inherited from @@ -142,7 +142,7 @@ The `meta` object passed in the mutation's options, if any. protected clearGcTimeout(): void; ``` -Defined in: [packages/query-core/src/removable.ts:32](https://github.com/TanStack/query/blob/main/packages/query-core/src/removable.ts#L32) +Defined in: [packages/query-core/src/removable.ts:41](https://github.com/TanStack/query/blob/main/packages/query-core/src/removable.ts#L41) #### Returns @@ -199,7 +199,11 @@ await mutation?.continue() destroy(): void; ``` -Defined in: [packages/query-core/src/removable.ts:10](https://github.com/TanStack/query/blob/main/packages/query-core/src/removable.ts#L10) +Defined in: [packages/query-core/src/removable.ts:19](https://github.com/TanStack/query/blob/main/packages/query-core/src/removable.ts#L19) + +Clears the pending garbage collection timeout, so the entry is no longer scheduled for removal. +A subclass may override this to release what it holds on to as well — `Query` also cancels any +in-flight fetch. #### Returns @@ -291,7 +295,7 @@ Removable.optionalRemove protected scheduleGc(): void; ``` -Defined in: [packages/query-core/src/removable.ts:14](https://github.com/TanStack/query/blob/main/packages/query-core/src/removable.ts#L14) +Defined in: [packages/query-core/src/removable.ts:23](https://github.com/TanStack/query/blob/main/packages/query-core/src/removable.ts#L23) #### Returns @@ -311,7 +315,7 @@ Removable.scheduleGc protected updateGcTime(newGcTime: number | undefined): void; ``` -Defined in: [packages/query-core/src/removable.ts:24](https://github.com/TanStack/query/blob/main/packages/query-core/src/removable.ts#L24) +Defined in: [packages/query-core/src/removable.ts:33](https://github.com/TanStack/query/blob/main/packages/query-core/src/removable.ts#L33) #### Parameters diff --git a/docs/framework/solid/reference/classes/MutationCache.md b/docs/framework/solid/reference/classes/MutationCache.md index 65015530c74..b64b17cf0e9 100644 --- a/docs/framework/solid/reference/classes/MutationCache.md +++ b/docs/framework/solid/reference/classes/MutationCache.md @@ -67,7 +67,7 @@ Defined in: [packages/query-core/src/mutationCache.ts:129](https://github.com/Ta protected listeners: Set; ``` -Defined in: [packages/query-core/src/subscribable.ts:2](https://github.com/TanStack/query/blob/main/packages/query-core/src/subscribable.ts#L2) +Defined in: [packages/query-core/src/subscribable.ts:7](https://github.com/TanStack/query/blob/main/packages/query-core/src/subscribable.ts#L7) #### Inherited from @@ -231,7 +231,9 @@ const mutations = mutationCache.getAll() hasListeners(): boolean; ``` -Defined in: [packages/query-core/src/subscribable.ts:19](https://github.com/TanStack/query/blob/main/packages/query-core/src/subscribable.ts#L19) +Defined in: [packages/query-core/src/subscribable.ts:41](https://github.com/TanStack/query/blob/main/packages/query-core/src/subscribable.ts#L41) + +Returns `true` while at least one listener is registered, `false` once they have all unsubscribed. #### Returns @@ -251,7 +253,7 @@ Subscribable.hasListeners protected onSubscribe(): void; ``` -Defined in: [packages/query-core/src/subscribable.ts:23](https://github.com/TanStack/query/blob/main/packages/query-core/src/subscribable.ts#L23) +Defined in: [packages/query-core/src/subscribable.ts:45](https://github.com/TanStack/query/blob/main/packages/query-core/src/subscribable.ts#L45) #### Returns @@ -271,7 +273,7 @@ Subscribable.onSubscribe protected onUnsubscribe(): void; ``` -Defined in: [packages/query-core/src/subscribable.ts:27](https://github.com/TanStack/query/blob/main/packages/query-core/src/subscribable.ts#L27) +Defined in: [packages/query-core/src/subscribable.ts:49](https://github.com/TanStack/query/blob/main/packages/query-core/src/subscribable.ts#L49) #### Returns @@ -291,7 +293,11 @@ Subscribable.onUnsubscribe subscribe(listener: MutationCacheListener): () => void; ``` -Defined in: [packages/query-core/src/subscribable.ts:8](https://github.com/TanStack/query/blob/main/packages/query-core/src/subscribable.ts#L8) +Defined in: [packages/query-core/src/subscribable.ts:27](https://github.com/TanStack/query/blob/main/packages/query-core/src/subscribable.ts#L27) + +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()`. #### Parameters @@ -299,6 +305,8 @@ Defined in: [packages/query-core/src/subscribable.ts:8](https://github.com/TanSt `MutationCacheListener` +Called on each update, with whatever the subclass passes to its subscribers. + #### Returns ```ts @@ -309,6 +317,16 @@ Defined in: [packages/query-core/src/subscribable.ts:8](https://github.com/TanSt `void` +#### Example + +```ts +const unsubscribe = subscribable.subscribe(() => { + // react to the update +}) + +unsubscribe() +``` + #### Inherited from ```ts diff --git a/docs/framework/solid/reference/classes/MutationObserver.md b/docs/framework/solid/reference/classes/MutationObserver.md index b0a5f850b74..769317ddfd2 100644 --- a/docs/framework/solid/reference/classes/MutationObserver.md +++ b/docs/framework/solid/reference/classes/MutationObserver.md @@ -82,7 +82,7 @@ Subscribable< protected listeners: Set>; ``` -Defined in: [packages/query-core/src/subscribable.ts:2](https://github.com/TanStack/query/blob/main/packages/query-core/src/subscribable.ts#L2) +Defined in: [packages/query-core/src/subscribable.ts:7](https://github.com/TanStack/query/blob/main/packages/query-core/src/subscribable.ts#L7) #### Inherited from @@ -140,7 +140,9 @@ built yet, e.g. before the first `mutate()` call or after `reset()`). hasListeners(): boolean; ``` -Defined in: [packages/query-core/src/subscribable.ts:19](https://github.com/TanStack/query/blob/main/packages/query-core/src/subscribable.ts#L19) +Defined in: [packages/query-core/src/subscribable.ts:41](https://github.com/TanStack/query/blob/main/packages/query-core/src/subscribable.ts#L41) + +Returns `true` while at least one listener is registered, `false` once they have all unsubscribed. #### Returns @@ -310,7 +312,11 @@ observer.setOptions({ subscribe(listener: MutationObserverListener): () => void; ``` -Defined in: [packages/query-core/src/subscribable.ts:8](https://github.com/TanStack/query/blob/main/packages/query-core/src/subscribable.ts#L8) +Defined in: [packages/query-core/src/subscribable.ts:27](https://github.com/TanStack/query/blob/main/packages/query-core/src/subscribable.ts#L27) + +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()`. #### Parameters @@ -318,6 +324,8 @@ Defined in: [packages/query-core/src/subscribable.ts:8](https://github.com/TanSt `MutationObserverListener` +Called on each update, with whatever the subclass passes to its subscribers. + #### Returns ```ts @@ -328,6 +336,16 @@ Defined in: [packages/query-core/src/subscribable.ts:8](https://github.com/TanSt `void` +#### Example + +```ts +const unsubscribe = subscribable.subscribe(() => { + // react to the update +}) + +unsubscribe() +``` + #### Inherited from ```ts diff --git a/docs/framework/solid/reference/classes/QueriesObserver.md b/docs/framework/solid/reference/classes/QueriesObserver.md index 0ab09d19e60..3d11965e5b1 100644 --- a/docs/framework/solid/reference/classes/QueriesObserver.md +++ b/docs/framework/solid/reference/classes/QueriesObserver.md @@ -79,7 +79,7 @@ Subscribable.constructor protected listeners: Set; ``` -Defined in: [packages/query-core/src/subscribable.ts:2](https://github.com/TanStack/query/blob/main/packages/query-core/src/subscribable.ts#L2) +Defined in: [packages/query-core/src/subscribable.ts:7](https://github.com/TanStack/query/blob/main/packages/query-core/src/subscribable.ts#L7) #### Inherited from @@ -202,7 +202,9 @@ the same order as the queries passed to the constructor or `setQueries`. hasListeners(): boolean; ``` -Defined in: [packages/query-core/src/subscribable.ts:19](https://github.com/TanStack/query/blob/main/packages/query-core/src/subscribable.ts#L19) +Defined in: [packages/query-core/src/subscribable.ts:41](https://github.com/TanStack/query/blob/main/packages/query-core/src/subscribable.ts#L41) + +Returns `true` while at least one listener is registered, `false` once they have all unsubscribed. #### Returns @@ -300,7 +302,11 @@ observer.setQueries([ subscribe(listener: QueriesObserverListener): () => void; ``` -Defined in: [packages/query-core/src/subscribable.ts:8](https://github.com/TanStack/query/blob/main/packages/query-core/src/subscribable.ts#L8) +Defined in: [packages/query-core/src/subscribable.ts:27](https://github.com/TanStack/query/blob/main/packages/query-core/src/subscribable.ts#L27) + +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()`. #### Parameters @@ -308,6 +314,8 @@ Defined in: [packages/query-core/src/subscribable.ts:8](https://github.com/TanSt `QueriesObserverListener` +Called on each update, with whatever the subclass passes to its subscribers. + #### Returns ```ts @@ -318,6 +326,16 @@ Defined in: [packages/query-core/src/subscribable.ts:8](https://github.com/TanSt `void` +#### Example + +```ts +const unsubscribe = subscribable.subscribe(() => { + // react to the update +}) + +unsubscribe() +``` + #### Inherited from ```ts diff --git a/docs/framework/solid/reference/classes/Query.md b/docs/framework/solid/reference/classes/Query.md index a996eb21a15..eca90a14360 100644 --- a/docs/framework/solid/reference/classes/Query.md +++ b/docs/framework/solid/reference/classes/Query.md @@ -80,7 +80,7 @@ Removable.constructor gcTime: number; ``` -Defined in: [packages/query-core/src/removable.ts:7](https://github.com/TanStack/query/blob/main/packages/query-core/src/removable.ts#L7) +Defined in: [packages/query-core/src/removable.ts:11](https://github.com/TanStack/query/blob/main/packages/query-core/src/removable.ts#L11) #### Inherited from @@ -213,7 +213,7 @@ await query.cancel() protected clearGcTimeout(): void; ``` -Defined in: [packages/query-core/src/removable.ts:32](https://github.com/TanStack/query/blob/main/packages/query-core/src/removable.ts#L32) +Defined in: [packages/query-core/src/removable.ts:41](https://github.com/TanStack/query/blob/main/packages/query-core/src/removable.ts#L41) #### Returns @@ -522,7 +522,7 @@ in-flight fetch. protected scheduleGc(): void; ``` -Defined in: [packages/query-core/src/removable.ts:14](https://github.com/TanStack/query/blob/main/packages/query-core/src/removable.ts#L14) +Defined in: [packages/query-core/src/removable.ts:23](https://github.com/TanStack/query/blob/main/packages/query-core/src/removable.ts#L23) #### Returns @@ -566,7 +566,7 @@ user manually trigger a loading/error state or edit the cached data. protected updateGcTime(newGcTime: number | undefined): void; ``` -Defined in: [packages/query-core/src/removable.ts:24](https://github.com/TanStack/query/blob/main/packages/query-core/src/removable.ts#L24) +Defined in: [packages/query-core/src/removable.ts:33](https://github.com/TanStack/query/blob/main/packages/query-core/src/removable.ts#L33) #### Parameters diff --git a/docs/framework/solid/reference/classes/QueryCache.md b/docs/framework/solid/reference/classes/QueryCache.md index fab04311c1b..3648ade0a07 100644 --- a/docs/framework/solid/reference/classes/QueryCache.md +++ b/docs/framework/solid/reference/classes/QueryCache.md @@ -70,7 +70,7 @@ Defined in: [packages/query-core/src/queryCache.ts:126](https://github.com/TanSt protected listeners: Set; ``` -Defined in: [packages/query-core/src/subscribable.ts:2](https://github.com/TanStack/query/blob/main/packages/query-core/src/subscribable.ts#L2) +Defined in: [packages/query-core/src/subscribable.ts:7](https://github.com/TanStack/query/blob/main/packages/query-core/src/subscribable.ts#L7) #### Inherited from @@ -350,7 +350,9 @@ const queries = queryCache.getAll() hasListeners(): boolean; ``` -Defined in: [packages/query-core/src/subscribable.ts:19](https://github.com/TanStack/query/blob/main/packages/query-core/src/subscribable.ts#L19) +Defined in: [packages/query-core/src/subscribable.ts:41](https://github.com/TanStack/query/blob/main/packages/query-core/src/subscribable.ts#L41) + +Returns `true` while at least one listener is registered, `false` once they have all unsubscribed. #### Returns @@ -370,7 +372,7 @@ Subscribable.hasListeners protected onSubscribe(): void; ``` -Defined in: [packages/query-core/src/subscribable.ts:23](https://github.com/TanStack/query/blob/main/packages/query-core/src/subscribable.ts#L23) +Defined in: [packages/query-core/src/subscribable.ts:45](https://github.com/TanStack/query/blob/main/packages/query-core/src/subscribable.ts#L45) #### Returns @@ -390,7 +392,7 @@ Subscribable.onSubscribe protected onUnsubscribe(): void; ``` -Defined in: [packages/query-core/src/subscribable.ts:27](https://github.com/TanStack/query/blob/main/packages/query-core/src/subscribable.ts#L27) +Defined in: [packages/query-core/src/subscribable.ts:49](https://github.com/TanStack/query/blob/main/packages/query-core/src/subscribable.ts#L49) #### Returns @@ -446,7 +448,11 @@ if (query) { subscribe(listener: QueryCacheListener): () => void; ``` -Defined in: [packages/query-core/src/subscribable.ts:8](https://github.com/TanStack/query/blob/main/packages/query-core/src/subscribable.ts#L8) +Defined in: [packages/query-core/src/subscribable.ts:27](https://github.com/TanStack/query/blob/main/packages/query-core/src/subscribable.ts#L27) + +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()`. #### Parameters @@ -454,6 +460,8 @@ Defined in: [packages/query-core/src/subscribable.ts:8](https://github.com/TanSt `QueryCacheListener` +Called on each update, with whatever the subclass passes to its subscribers. + #### Returns ```ts @@ -464,6 +472,16 @@ Defined in: [packages/query-core/src/subscribable.ts:8](https://github.com/TanSt `void` +#### Example + +```ts +const unsubscribe = subscribable.subscribe(() => { + // react to the update +}) + +unsubscribe() +``` + #### Inherited from ```ts diff --git a/docs/framework/solid/reference/classes/QueryObserver.md b/docs/framework/solid/reference/classes/QueryObserver.md index 87b45f54c5f..641e19b5b49 100644 --- a/docs/framework/solid/reference/classes/QueryObserver.md +++ b/docs/framework/solid/reference/classes/QueryObserver.md @@ -93,7 +93,7 @@ Subscribable>.constructor protected listeners: Set>; ``` -Defined in: [packages/query-core/src/subscribable.ts:2](https://github.com/TanStack/query/blob/main/packages/query-core/src/subscribable.ts#L2) +Defined in: [packages/query-core/src/subscribable.ts:7](https://github.com/TanStack/query/blob/main/packages/query-core/src/subscribable.ts#L7) #### Inherited from @@ -298,7 +298,9 @@ returned value is available synchronously, ahead of `setOptions` triggering an a hasListeners(): boolean; ``` -Defined in: [packages/query-core/src/subscribable.ts:19](https://github.com/TanStack/query/blob/main/packages/query-core/src/subscribable.ts#L19) +Defined in: [packages/query-core/src/subscribable.ts:41](https://github.com/TanStack/query/blob/main/packages/query-core/src/subscribable.ts#L41) + +Returns `true` while at least one listener is registered, `false` once they have all unsubscribed. #### Returns @@ -458,7 +460,11 @@ regains focus. subscribe(listener: QueryObserverListener): () => void; ``` -Defined in: [packages/query-core/src/subscribable.ts:8](https://github.com/TanStack/query/blob/main/packages/query-core/src/subscribable.ts#L8) +Defined in: [packages/query-core/src/subscribable.ts:27](https://github.com/TanStack/query/blob/main/packages/query-core/src/subscribable.ts#L27) + +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()`. #### Parameters @@ -466,6 +472,8 @@ Defined in: [packages/query-core/src/subscribable.ts:8](https://github.com/TanSt `QueryObserverListener` +Called on each update, with whatever the subclass passes to its subscribers. + #### Returns ```ts @@ -476,6 +484,16 @@ Defined in: [packages/query-core/src/subscribable.ts:8](https://github.com/TanSt `void` +#### Example + +```ts +const unsubscribe = subscribable.subscribe(() => { + // react to the update +}) + +unsubscribe() +``` + #### Inherited from ```ts diff --git a/docs/framework/solid/reference/interfaces/FocusManager.md b/docs/framework/solid/reference/interfaces/FocusManager.md index 63e0813388a..c0e6c1dcf22 100644 --- a/docs/framework/solid/reference/interfaces/FocusManager.md +++ b/docs/framework/solid/reference/interfaces/FocusManager.md @@ -27,7 +27,9 @@ It can be used to change the default event listeners or to manually change the f hasListeners(): boolean; ``` -Defined in: [packages/query-core/src/subscribable.ts:19](https://github.com/TanStack/query/blob/main/packages/query-core/src/subscribable.ts#L19) +Defined in: [packages/query-core/src/subscribable.ts:41](https://github.com/TanStack/query/blob/main/packages/query-core/src/subscribable.ts#L41) + +Returns `true` while at least one listener is registered, `false` once they have all unsubscribed. #### Returns @@ -202,7 +204,11 @@ focusManager.setFocused(undefined) subscribe(listener: Listener): () => void; ``` -Defined in: [packages/query-core/src/subscribable.ts:8](https://github.com/TanStack/query/blob/main/packages/query-core/src/subscribable.ts#L8) +Defined in: [packages/query-core/src/subscribable.ts:27](https://github.com/TanStack/query/blob/main/packages/query-core/src/subscribable.ts#L27) + +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()`. #### Parameters @@ -210,6 +216,8 @@ Defined in: [packages/query-core/src/subscribable.ts:8](https://github.com/TanSt `Listener` +Called on each update, with whatever the subclass passes to its subscribers. + #### Returns ```ts @@ -220,6 +228,16 @@ Defined in: [packages/query-core/src/subscribable.ts:8](https://github.com/TanSt `void` +#### Example + +```ts +const unsubscribe = subscribable.subscribe(() => { + // react to the update +}) + +unsubscribe() +``` + #### Inherited from ```ts diff --git a/docs/framework/solid/reference/interfaces/OnlineManager.md b/docs/framework/solid/reference/interfaces/OnlineManager.md index 6f0f71074db..e9f911fce4e 100644 --- a/docs/framework/solid/reference/interfaces/OnlineManager.md +++ b/docs/framework/solid/reference/interfaces/OnlineManager.md @@ -31,7 +31,9 @@ detect changes. hasListeners(): boolean; ``` -Defined in: [packages/query-core/src/subscribable.ts:19](https://github.com/TanStack/query/blob/main/packages/query-core/src/subscribable.ts#L19) +Defined in: [packages/query-core/src/subscribable.ts:41](https://github.com/TanStack/query/blob/main/packages/query-core/src/subscribable.ts#L41) + +Returns `true` while at least one listener is registered, `false` once they have all unsubscribed. #### Returns @@ -179,7 +181,11 @@ onlineManager.setOnline(false) subscribe(listener: Listener): () => void; ``` -Defined in: [packages/query-core/src/subscribable.ts:8](https://github.com/TanStack/query/blob/main/packages/query-core/src/subscribable.ts#L8) +Defined in: [packages/query-core/src/subscribable.ts:27](https://github.com/TanStack/query/blob/main/packages/query-core/src/subscribable.ts#L27) + +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()`. #### Parameters @@ -187,6 +193,8 @@ Defined in: [packages/query-core/src/subscribable.ts:8](https://github.com/TanSt `Listener` +Called on each update, with whatever the subclass passes to its subscribers. + #### Returns ```ts @@ -197,6 +205,16 @@ Defined in: [packages/query-core/src/subscribable.ts:8](https://github.com/TanSt `void` +#### Example + +```ts +const unsubscribe = subscribable.subscribe(() => { + // react to the update +}) + +unsubscribe() +``` + #### Inherited from ```ts diff --git a/docs/framework/svelte/reference/classes/InfiniteQueryObserver.md b/docs/framework/svelte/reference/classes/InfiniteQueryObserver.md index 0fc1765d488..5453760e839 100644 --- a/docs/framework/svelte/reference/classes/InfiniteQueryObserver.md +++ b/docs/framework/svelte/reference/classes/InfiniteQueryObserver.md @@ -130,7 +130,7 @@ QueryObserver.getCurrentResult protected listeners: Set>; ``` -Defined in: [packages/query-core/src/subscribable.ts:2](https://github.com/TanStack/query/blob/main/packages/query-core/src/subscribable.ts#L2) +Defined in: [packages/query-core/src/subscribable.ts:7](https://github.com/TanStack/query/blob/main/packages/query-core/src/subscribable.ts#L7) #### Inherited from @@ -160,12 +160,18 @@ subscribe: (listener: InfiniteQueryObserverListener) => () => void; Defined in: [packages/query-core/src/infiniteQueryObserver.ts:55](https://github.com/TanStack/query/blob/main/packages/query-core/src/infiniteQueryObserver.ts#L55) +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()`. + #### Parameters ##### listener `InfiniteQueryObserverListener` +Called on each update, with whatever the subclass passes to its subscribers. + #### Returns ```ts @@ -176,6 +182,16 @@ Defined in: [packages/query-core/src/infiniteQueryObserver.ts:55](https://github `void` +#### Example + +```ts +const unsubscribe = subscribable.subscribe(() => { + // react to the update +}) + +unsubscribe() +``` + #### Overrides ```ts @@ -427,7 +443,9 @@ synchronously. hasListeners(): boolean; ``` -Defined in: [packages/query-core/src/subscribable.ts:19](https://github.com/TanStack/query/blob/main/packages/query-core/src/subscribable.ts#L19) +Defined in: [packages/query-core/src/subscribable.ts:41](https://github.com/TanStack/query/blob/main/packages/query-core/src/subscribable.ts#L41) + +Returns `true` while at least one listener is registered, `false` once they have all unsubscribed. #### Returns diff --git a/docs/framework/svelte/reference/classes/Mutation.md b/docs/framework/svelte/reference/classes/Mutation.md index fa3b9c79522..49975b76a75 100644 --- a/docs/framework/svelte/reference/classes/Mutation.md +++ b/docs/framework/svelte/reference/classes/Mutation.md @@ -78,7 +78,7 @@ Removable.constructor gcTime: number; ``` -Defined in: [packages/query-core/src/removable.ts:7](https://github.com/TanStack/query/blob/main/packages/query-core/src/removable.ts#L7) +Defined in: [packages/query-core/src/removable.ts:11](https://github.com/TanStack/query/blob/main/packages/query-core/src/removable.ts#L11) #### Inherited from @@ -142,7 +142,7 @@ The `meta` object passed in the mutation's options, if any. protected clearGcTimeout(): void; ``` -Defined in: [packages/query-core/src/removable.ts:32](https://github.com/TanStack/query/blob/main/packages/query-core/src/removable.ts#L32) +Defined in: [packages/query-core/src/removable.ts:41](https://github.com/TanStack/query/blob/main/packages/query-core/src/removable.ts#L41) #### Returns @@ -199,7 +199,11 @@ await mutation?.continue() destroy(): void; ``` -Defined in: [packages/query-core/src/removable.ts:10](https://github.com/TanStack/query/blob/main/packages/query-core/src/removable.ts#L10) +Defined in: [packages/query-core/src/removable.ts:19](https://github.com/TanStack/query/blob/main/packages/query-core/src/removable.ts#L19) + +Clears the pending garbage collection timeout, so the entry is no longer scheduled for removal. +A subclass may override this to release what it holds on to as well — `Query` also cancels any +in-flight fetch. #### Returns @@ -291,7 +295,7 @@ Removable.optionalRemove protected scheduleGc(): void; ``` -Defined in: [packages/query-core/src/removable.ts:14](https://github.com/TanStack/query/blob/main/packages/query-core/src/removable.ts#L14) +Defined in: [packages/query-core/src/removable.ts:23](https://github.com/TanStack/query/blob/main/packages/query-core/src/removable.ts#L23) #### Returns @@ -311,7 +315,7 @@ Removable.scheduleGc protected updateGcTime(newGcTime: number | undefined): void; ``` -Defined in: [packages/query-core/src/removable.ts:24](https://github.com/TanStack/query/blob/main/packages/query-core/src/removable.ts#L24) +Defined in: [packages/query-core/src/removable.ts:33](https://github.com/TanStack/query/blob/main/packages/query-core/src/removable.ts#L33) #### Parameters diff --git a/docs/framework/svelte/reference/classes/MutationCache.md b/docs/framework/svelte/reference/classes/MutationCache.md index 65015530c74..b64b17cf0e9 100644 --- a/docs/framework/svelte/reference/classes/MutationCache.md +++ b/docs/framework/svelte/reference/classes/MutationCache.md @@ -67,7 +67,7 @@ Defined in: [packages/query-core/src/mutationCache.ts:129](https://github.com/Ta protected listeners: Set; ``` -Defined in: [packages/query-core/src/subscribable.ts:2](https://github.com/TanStack/query/blob/main/packages/query-core/src/subscribable.ts#L2) +Defined in: [packages/query-core/src/subscribable.ts:7](https://github.com/TanStack/query/blob/main/packages/query-core/src/subscribable.ts#L7) #### Inherited from @@ -231,7 +231,9 @@ const mutations = mutationCache.getAll() hasListeners(): boolean; ``` -Defined in: [packages/query-core/src/subscribable.ts:19](https://github.com/TanStack/query/blob/main/packages/query-core/src/subscribable.ts#L19) +Defined in: [packages/query-core/src/subscribable.ts:41](https://github.com/TanStack/query/blob/main/packages/query-core/src/subscribable.ts#L41) + +Returns `true` while at least one listener is registered, `false` once they have all unsubscribed. #### Returns @@ -251,7 +253,7 @@ Subscribable.hasListeners protected onSubscribe(): void; ``` -Defined in: [packages/query-core/src/subscribable.ts:23](https://github.com/TanStack/query/blob/main/packages/query-core/src/subscribable.ts#L23) +Defined in: [packages/query-core/src/subscribable.ts:45](https://github.com/TanStack/query/blob/main/packages/query-core/src/subscribable.ts#L45) #### Returns @@ -271,7 +273,7 @@ Subscribable.onSubscribe protected onUnsubscribe(): void; ``` -Defined in: [packages/query-core/src/subscribable.ts:27](https://github.com/TanStack/query/blob/main/packages/query-core/src/subscribable.ts#L27) +Defined in: [packages/query-core/src/subscribable.ts:49](https://github.com/TanStack/query/blob/main/packages/query-core/src/subscribable.ts#L49) #### Returns @@ -291,7 +293,11 @@ Subscribable.onUnsubscribe subscribe(listener: MutationCacheListener): () => void; ``` -Defined in: [packages/query-core/src/subscribable.ts:8](https://github.com/TanStack/query/blob/main/packages/query-core/src/subscribable.ts#L8) +Defined in: [packages/query-core/src/subscribable.ts:27](https://github.com/TanStack/query/blob/main/packages/query-core/src/subscribable.ts#L27) + +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()`. #### Parameters @@ -299,6 +305,8 @@ Defined in: [packages/query-core/src/subscribable.ts:8](https://github.com/TanSt `MutationCacheListener` +Called on each update, with whatever the subclass passes to its subscribers. + #### Returns ```ts @@ -309,6 +317,16 @@ Defined in: [packages/query-core/src/subscribable.ts:8](https://github.com/TanSt `void` +#### Example + +```ts +const unsubscribe = subscribable.subscribe(() => { + // react to the update +}) + +unsubscribe() +``` + #### Inherited from ```ts diff --git a/docs/framework/svelte/reference/classes/MutationObserver.md b/docs/framework/svelte/reference/classes/MutationObserver.md index 90bac0ff994..e8ba6146fb3 100644 --- a/docs/framework/svelte/reference/classes/MutationObserver.md +++ b/docs/framework/svelte/reference/classes/MutationObserver.md @@ -82,7 +82,7 @@ Subscribable< protected listeners: Set>; ``` -Defined in: [packages/query-core/src/subscribable.ts:2](https://github.com/TanStack/query/blob/main/packages/query-core/src/subscribable.ts#L2) +Defined in: [packages/query-core/src/subscribable.ts:7](https://github.com/TanStack/query/blob/main/packages/query-core/src/subscribable.ts#L7) #### Inherited from @@ -140,7 +140,9 @@ built yet, e.g. before the first `mutate()` call or after `reset()`). hasListeners(): boolean; ``` -Defined in: [packages/query-core/src/subscribable.ts:19](https://github.com/TanStack/query/blob/main/packages/query-core/src/subscribable.ts#L19) +Defined in: [packages/query-core/src/subscribable.ts:41](https://github.com/TanStack/query/blob/main/packages/query-core/src/subscribable.ts#L41) + +Returns `true` while at least one listener is registered, `false` once they have all unsubscribed. #### Returns @@ -310,7 +312,11 @@ observer.setOptions({ subscribe(listener: MutationObserverListener): () => void; ``` -Defined in: [packages/query-core/src/subscribable.ts:8](https://github.com/TanStack/query/blob/main/packages/query-core/src/subscribable.ts#L8) +Defined in: [packages/query-core/src/subscribable.ts:27](https://github.com/TanStack/query/blob/main/packages/query-core/src/subscribable.ts#L27) + +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()`. #### Parameters @@ -318,6 +324,8 @@ Defined in: [packages/query-core/src/subscribable.ts:8](https://github.com/TanSt `MutationObserverListener` +Called on each update, with whatever the subclass passes to its subscribers. + #### Returns ```ts @@ -328,6 +336,16 @@ Defined in: [packages/query-core/src/subscribable.ts:8](https://github.com/TanSt `void` +#### Example + +```ts +const unsubscribe = subscribable.subscribe(() => { + // react to the update +}) + +unsubscribe() +``` + #### Inherited from ```ts diff --git a/docs/framework/svelte/reference/classes/QueriesObserver.md b/docs/framework/svelte/reference/classes/QueriesObserver.md index 8bf48fdbebe..ebcbcd9cc97 100644 --- a/docs/framework/svelte/reference/classes/QueriesObserver.md +++ b/docs/framework/svelte/reference/classes/QueriesObserver.md @@ -79,7 +79,7 @@ Subscribable.constructor protected listeners: Set; ``` -Defined in: [packages/query-core/src/subscribable.ts:2](https://github.com/TanStack/query/blob/main/packages/query-core/src/subscribable.ts#L2) +Defined in: [packages/query-core/src/subscribable.ts:7](https://github.com/TanStack/query/blob/main/packages/query-core/src/subscribable.ts#L7) #### Inherited from @@ -202,7 +202,9 @@ the same order as the queries passed to the constructor or `setQueries`. hasListeners(): boolean; ``` -Defined in: [packages/query-core/src/subscribable.ts:19](https://github.com/TanStack/query/blob/main/packages/query-core/src/subscribable.ts#L19) +Defined in: [packages/query-core/src/subscribable.ts:41](https://github.com/TanStack/query/blob/main/packages/query-core/src/subscribable.ts#L41) + +Returns `true` while at least one listener is registered, `false` once they have all unsubscribed. #### Returns @@ -300,7 +302,11 @@ observer.setQueries([ subscribe(listener: QueriesObserverListener): () => void; ``` -Defined in: [packages/query-core/src/subscribable.ts:8](https://github.com/TanStack/query/blob/main/packages/query-core/src/subscribable.ts#L8) +Defined in: [packages/query-core/src/subscribable.ts:27](https://github.com/TanStack/query/blob/main/packages/query-core/src/subscribable.ts#L27) + +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()`. #### Parameters @@ -308,6 +314,8 @@ Defined in: [packages/query-core/src/subscribable.ts:8](https://github.com/TanSt `QueriesObserverListener` +Called on each update, with whatever the subclass passes to its subscribers. + #### Returns ```ts @@ -318,6 +326,16 @@ Defined in: [packages/query-core/src/subscribable.ts:8](https://github.com/TanSt `void` +#### Example + +```ts +const unsubscribe = subscribable.subscribe(() => { + // react to the update +}) + +unsubscribe() +``` + #### Inherited from ```ts diff --git a/docs/framework/svelte/reference/classes/Query.md b/docs/framework/svelte/reference/classes/Query.md index fee2fb07529..646028952e1 100644 --- a/docs/framework/svelte/reference/classes/Query.md +++ b/docs/framework/svelte/reference/classes/Query.md @@ -80,7 +80,7 @@ Removable.constructor gcTime: number; ``` -Defined in: [packages/query-core/src/removable.ts:7](https://github.com/TanStack/query/blob/main/packages/query-core/src/removable.ts#L7) +Defined in: [packages/query-core/src/removable.ts:11](https://github.com/TanStack/query/blob/main/packages/query-core/src/removable.ts#L11) #### Inherited from @@ -213,7 +213,7 @@ await query.cancel() protected clearGcTimeout(): void; ``` -Defined in: [packages/query-core/src/removable.ts:32](https://github.com/TanStack/query/blob/main/packages/query-core/src/removable.ts#L32) +Defined in: [packages/query-core/src/removable.ts:41](https://github.com/TanStack/query/blob/main/packages/query-core/src/removable.ts#L41) #### Returns @@ -522,7 +522,7 @@ in-flight fetch. protected scheduleGc(): void; ``` -Defined in: [packages/query-core/src/removable.ts:14](https://github.com/TanStack/query/blob/main/packages/query-core/src/removable.ts#L14) +Defined in: [packages/query-core/src/removable.ts:23](https://github.com/TanStack/query/blob/main/packages/query-core/src/removable.ts#L23) #### Returns @@ -566,7 +566,7 @@ user manually trigger a loading/error state or edit the cached data. protected updateGcTime(newGcTime: number | undefined): void; ``` -Defined in: [packages/query-core/src/removable.ts:24](https://github.com/TanStack/query/blob/main/packages/query-core/src/removable.ts#L24) +Defined in: [packages/query-core/src/removable.ts:33](https://github.com/TanStack/query/blob/main/packages/query-core/src/removable.ts#L33) #### Parameters diff --git a/docs/framework/svelte/reference/classes/QueryCache.md b/docs/framework/svelte/reference/classes/QueryCache.md index 982a6e72fb9..18520030db7 100644 --- a/docs/framework/svelte/reference/classes/QueryCache.md +++ b/docs/framework/svelte/reference/classes/QueryCache.md @@ -70,7 +70,7 @@ Defined in: [packages/query-core/src/queryCache.ts:126](https://github.com/TanSt protected listeners: Set; ``` -Defined in: [packages/query-core/src/subscribable.ts:2](https://github.com/TanStack/query/blob/main/packages/query-core/src/subscribable.ts#L2) +Defined in: [packages/query-core/src/subscribable.ts:7](https://github.com/TanStack/query/blob/main/packages/query-core/src/subscribable.ts#L7) #### Inherited from @@ -350,7 +350,9 @@ const queries = queryCache.getAll() hasListeners(): boolean; ``` -Defined in: [packages/query-core/src/subscribable.ts:19](https://github.com/TanStack/query/blob/main/packages/query-core/src/subscribable.ts#L19) +Defined in: [packages/query-core/src/subscribable.ts:41](https://github.com/TanStack/query/blob/main/packages/query-core/src/subscribable.ts#L41) + +Returns `true` while at least one listener is registered, `false` once they have all unsubscribed. #### Returns @@ -370,7 +372,7 @@ Subscribable.hasListeners protected onSubscribe(): void; ``` -Defined in: [packages/query-core/src/subscribable.ts:23](https://github.com/TanStack/query/blob/main/packages/query-core/src/subscribable.ts#L23) +Defined in: [packages/query-core/src/subscribable.ts:45](https://github.com/TanStack/query/blob/main/packages/query-core/src/subscribable.ts#L45) #### Returns @@ -390,7 +392,7 @@ Subscribable.onSubscribe protected onUnsubscribe(): void; ``` -Defined in: [packages/query-core/src/subscribable.ts:27](https://github.com/TanStack/query/blob/main/packages/query-core/src/subscribable.ts#L27) +Defined in: [packages/query-core/src/subscribable.ts:49](https://github.com/TanStack/query/blob/main/packages/query-core/src/subscribable.ts#L49) #### Returns @@ -446,7 +448,11 @@ if (query) { subscribe(listener: QueryCacheListener): () => void; ``` -Defined in: [packages/query-core/src/subscribable.ts:8](https://github.com/TanStack/query/blob/main/packages/query-core/src/subscribable.ts#L8) +Defined in: [packages/query-core/src/subscribable.ts:27](https://github.com/TanStack/query/blob/main/packages/query-core/src/subscribable.ts#L27) + +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()`. #### Parameters @@ -454,6 +460,8 @@ Defined in: [packages/query-core/src/subscribable.ts:8](https://github.com/TanSt `QueryCacheListener` +Called on each update, with whatever the subclass passes to its subscribers. + #### Returns ```ts @@ -464,6 +472,16 @@ Defined in: [packages/query-core/src/subscribable.ts:8](https://github.com/TanSt `void` +#### Example + +```ts +const unsubscribe = subscribable.subscribe(() => { + // react to the update +}) + +unsubscribe() +``` + #### Inherited from ```ts diff --git a/docs/framework/svelte/reference/classes/QueryObserver.md b/docs/framework/svelte/reference/classes/QueryObserver.md index 8f5dd48169e..ba20c873925 100644 --- a/docs/framework/svelte/reference/classes/QueryObserver.md +++ b/docs/framework/svelte/reference/classes/QueryObserver.md @@ -93,7 +93,7 @@ Subscribable>.constructor protected listeners: Set>; ``` -Defined in: [packages/query-core/src/subscribable.ts:2](https://github.com/TanStack/query/blob/main/packages/query-core/src/subscribable.ts#L2) +Defined in: [packages/query-core/src/subscribable.ts:7](https://github.com/TanStack/query/blob/main/packages/query-core/src/subscribable.ts#L7) #### Inherited from @@ -298,7 +298,9 @@ returned value is available synchronously, ahead of `setOptions` triggering an a hasListeners(): boolean; ``` -Defined in: [packages/query-core/src/subscribable.ts:19](https://github.com/TanStack/query/blob/main/packages/query-core/src/subscribable.ts#L19) +Defined in: [packages/query-core/src/subscribable.ts:41](https://github.com/TanStack/query/blob/main/packages/query-core/src/subscribable.ts#L41) + +Returns `true` while at least one listener is registered, `false` once they have all unsubscribed. #### Returns @@ -458,7 +460,11 @@ regains focus. subscribe(listener: QueryObserverListener): () => void; ``` -Defined in: [packages/query-core/src/subscribable.ts:8](https://github.com/TanStack/query/blob/main/packages/query-core/src/subscribable.ts#L8) +Defined in: [packages/query-core/src/subscribable.ts:27](https://github.com/TanStack/query/blob/main/packages/query-core/src/subscribable.ts#L27) + +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()`. #### Parameters @@ -466,6 +472,8 @@ Defined in: [packages/query-core/src/subscribable.ts:8](https://github.com/TanSt `QueryObserverListener` +Called on each update, with whatever the subclass passes to its subscribers. + #### Returns ```ts @@ -476,6 +484,16 @@ Defined in: [packages/query-core/src/subscribable.ts:8](https://github.com/TanSt `void` +#### Example + +```ts +const unsubscribe = subscribable.subscribe(() => { + // react to the update +}) + +unsubscribe() +``` + #### Inherited from ```ts diff --git a/docs/framework/svelte/reference/interfaces/FocusManager.md b/docs/framework/svelte/reference/interfaces/FocusManager.md index 63e0813388a..c0e6c1dcf22 100644 --- a/docs/framework/svelte/reference/interfaces/FocusManager.md +++ b/docs/framework/svelte/reference/interfaces/FocusManager.md @@ -27,7 +27,9 @@ It can be used to change the default event listeners or to manually change the f hasListeners(): boolean; ``` -Defined in: [packages/query-core/src/subscribable.ts:19](https://github.com/TanStack/query/blob/main/packages/query-core/src/subscribable.ts#L19) +Defined in: [packages/query-core/src/subscribable.ts:41](https://github.com/TanStack/query/blob/main/packages/query-core/src/subscribable.ts#L41) + +Returns `true` while at least one listener is registered, `false` once they have all unsubscribed. #### Returns @@ -202,7 +204,11 @@ focusManager.setFocused(undefined) subscribe(listener: Listener): () => void; ``` -Defined in: [packages/query-core/src/subscribable.ts:8](https://github.com/TanStack/query/blob/main/packages/query-core/src/subscribable.ts#L8) +Defined in: [packages/query-core/src/subscribable.ts:27](https://github.com/TanStack/query/blob/main/packages/query-core/src/subscribable.ts#L27) + +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()`. #### Parameters @@ -210,6 +216,8 @@ Defined in: [packages/query-core/src/subscribable.ts:8](https://github.com/TanSt `Listener` +Called on each update, with whatever the subclass passes to its subscribers. + #### Returns ```ts @@ -220,6 +228,16 @@ Defined in: [packages/query-core/src/subscribable.ts:8](https://github.com/TanSt `void` +#### Example + +```ts +const unsubscribe = subscribable.subscribe(() => { + // react to the update +}) + +unsubscribe() +``` + #### Inherited from ```ts diff --git a/docs/framework/svelte/reference/interfaces/OnlineManager.md b/docs/framework/svelte/reference/interfaces/OnlineManager.md index 6f0f71074db..e9f911fce4e 100644 --- a/docs/framework/svelte/reference/interfaces/OnlineManager.md +++ b/docs/framework/svelte/reference/interfaces/OnlineManager.md @@ -31,7 +31,9 @@ detect changes. hasListeners(): boolean; ``` -Defined in: [packages/query-core/src/subscribable.ts:19](https://github.com/TanStack/query/blob/main/packages/query-core/src/subscribable.ts#L19) +Defined in: [packages/query-core/src/subscribable.ts:41](https://github.com/TanStack/query/blob/main/packages/query-core/src/subscribable.ts#L41) + +Returns `true` while at least one listener is registered, `false` once they have all unsubscribed. #### Returns @@ -179,7 +181,11 @@ onlineManager.setOnline(false) subscribe(listener: Listener): () => void; ``` -Defined in: [packages/query-core/src/subscribable.ts:8](https://github.com/TanStack/query/blob/main/packages/query-core/src/subscribable.ts#L8) +Defined in: [packages/query-core/src/subscribable.ts:27](https://github.com/TanStack/query/blob/main/packages/query-core/src/subscribable.ts#L27) + +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()`. #### Parameters @@ -187,6 +193,8 @@ Defined in: [packages/query-core/src/subscribable.ts:8](https://github.com/TanSt `Listener` +Called on each update, with whatever the subclass passes to its subscribers. + #### Returns ```ts @@ -197,6 +205,16 @@ Defined in: [packages/query-core/src/subscribable.ts:8](https://github.com/TanSt `void` +#### Example + +```ts +const unsubscribe = subscribable.subscribe(() => { + // react to the update +}) + +unsubscribe() +``` + #### Inherited from ```ts diff --git a/docs/framework/vue/reference/classes/InfiniteQueryObserver.md b/docs/framework/vue/reference/classes/InfiniteQueryObserver.md index 7553204ff87..85aefa3cd2b 100644 --- a/docs/framework/vue/reference/classes/InfiniteQueryObserver.md +++ b/docs/framework/vue/reference/classes/InfiniteQueryObserver.md @@ -130,7 +130,7 @@ QueryObserver.getCurrentResult protected listeners: Set>; ``` -Defined in: [packages/query-core/src/subscribable.ts:2](https://github.com/TanStack/query/blob/main/packages/query-core/src/subscribable.ts#L2) +Defined in: [packages/query-core/src/subscribable.ts:7](https://github.com/TanStack/query/blob/main/packages/query-core/src/subscribable.ts#L7) #### Inherited from @@ -160,12 +160,18 @@ subscribe: (listener: InfiniteQueryObserverListener) => () => void; Defined in: [packages/query-core/src/infiniteQueryObserver.ts:55](https://github.com/TanStack/query/blob/main/packages/query-core/src/infiniteQueryObserver.ts#L55) +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()`. + #### Parameters ##### listener `InfiniteQueryObserverListener` +Called on each update, with whatever the subclass passes to its subscribers. + #### Returns ```ts @@ -176,6 +182,16 @@ Defined in: [packages/query-core/src/infiniteQueryObserver.ts:55](https://github `void` +#### Example + +```ts +const unsubscribe = subscribable.subscribe(() => { + // react to the update +}) + +unsubscribe() +``` + #### Overrides ```ts @@ -427,7 +443,9 @@ synchronously. hasListeners(): boolean; ``` -Defined in: [packages/query-core/src/subscribable.ts:19](https://github.com/TanStack/query/blob/main/packages/query-core/src/subscribable.ts#L19) +Defined in: [packages/query-core/src/subscribable.ts:41](https://github.com/TanStack/query/blob/main/packages/query-core/src/subscribable.ts#L41) + +Returns `true` while at least one listener is registered, `false` once they have all unsubscribed. #### Returns diff --git a/docs/framework/vue/reference/classes/Mutation.md b/docs/framework/vue/reference/classes/Mutation.md index fa3b9c79522..49975b76a75 100644 --- a/docs/framework/vue/reference/classes/Mutation.md +++ b/docs/framework/vue/reference/classes/Mutation.md @@ -78,7 +78,7 @@ Removable.constructor gcTime: number; ``` -Defined in: [packages/query-core/src/removable.ts:7](https://github.com/TanStack/query/blob/main/packages/query-core/src/removable.ts#L7) +Defined in: [packages/query-core/src/removable.ts:11](https://github.com/TanStack/query/blob/main/packages/query-core/src/removable.ts#L11) #### Inherited from @@ -142,7 +142,7 @@ The `meta` object passed in the mutation's options, if any. protected clearGcTimeout(): void; ``` -Defined in: [packages/query-core/src/removable.ts:32](https://github.com/TanStack/query/blob/main/packages/query-core/src/removable.ts#L32) +Defined in: [packages/query-core/src/removable.ts:41](https://github.com/TanStack/query/blob/main/packages/query-core/src/removable.ts#L41) #### Returns @@ -199,7 +199,11 @@ await mutation?.continue() destroy(): void; ``` -Defined in: [packages/query-core/src/removable.ts:10](https://github.com/TanStack/query/blob/main/packages/query-core/src/removable.ts#L10) +Defined in: [packages/query-core/src/removable.ts:19](https://github.com/TanStack/query/blob/main/packages/query-core/src/removable.ts#L19) + +Clears the pending garbage collection timeout, so the entry is no longer scheduled for removal. +A subclass may override this to release what it holds on to as well — `Query` also cancels any +in-flight fetch. #### Returns @@ -291,7 +295,7 @@ Removable.optionalRemove protected scheduleGc(): void; ``` -Defined in: [packages/query-core/src/removable.ts:14](https://github.com/TanStack/query/blob/main/packages/query-core/src/removable.ts#L14) +Defined in: [packages/query-core/src/removable.ts:23](https://github.com/TanStack/query/blob/main/packages/query-core/src/removable.ts#L23) #### Returns @@ -311,7 +315,7 @@ Removable.scheduleGc protected updateGcTime(newGcTime: number | undefined): void; ``` -Defined in: [packages/query-core/src/removable.ts:24](https://github.com/TanStack/query/blob/main/packages/query-core/src/removable.ts#L24) +Defined in: [packages/query-core/src/removable.ts:33](https://github.com/TanStack/query/blob/main/packages/query-core/src/removable.ts#L33) #### Parameters diff --git a/docs/framework/vue/reference/classes/MutationCache.md b/docs/framework/vue/reference/classes/MutationCache.md index 4b17e1412af..00bcfdd16a5 100644 --- a/docs/framework/vue/reference/classes/MutationCache.md +++ b/docs/framework/vue/reference/classes/MutationCache.md @@ -63,7 +63,7 @@ MC.config protected listeners: Set; ``` -Defined in: [packages/query-core/src/subscribable.ts:2](https://github.com/TanStack/query/blob/main/packages/query-core/src/subscribable.ts#L2) +Defined in: [packages/query-core/src/subscribable.ts:7](https://github.com/TanStack/query/blob/main/packages/query-core/src/subscribable.ts#L7) #### Inherited from @@ -251,7 +251,9 @@ MC.getAll hasListeners(): boolean; ``` -Defined in: [packages/query-core/src/subscribable.ts:19](https://github.com/TanStack/query/blob/main/packages/query-core/src/subscribable.ts#L19) +Defined in: [packages/query-core/src/subscribable.ts:41](https://github.com/TanStack/query/blob/main/packages/query-core/src/subscribable.ts#L41) + +Returns `true` while at least one listener is registered, `false` once they have all unsubscribed. #### Returns @@ -271,7 +273,7 @@ MC.hasListeners protected onSubscribe(): void; ``` -Defined in: [packages/query-core/src/subscribable.ts:23](https://github.com/TanStack/query/blob/main/packages/query-core/src/subscribable.ts#L23) +Defined in: [packages/query-core/src/subscribable.ts:45](https://github.com/TanStack/query/blob/main/packages/query-core/src/subscribable.ts#L45) #### Returns @@ -291,7 +293,7 @@ MC.onSubscribe protected onUnsubscribe(): void; ``` -Defined in: [packages/query-core/src/subscribable.ts:27](https://github.com/TanStack/query/blob/main/packages/query-core/src/subscribable.ts#L27) +Defined in: [packages/query-core/src/subscribable.ts:49](https://github.com/TanStack/query/blob/main/packages/query-core/src/subscribable.ts#L49) #### Returns @@ -311,7 +313,11 @@ MC.onUnsubscribe subscribe(listener: MutationCacheListener): () => void; ``` -Defined in: [packages/query-core/src/subscribable.ts:8](https://github.com/TanStack/query/blob/main/packages/query-core/src/subscribable.ts#L8) +Defined in: [packages/query-core/src/subscribable.ts:27](https://github.com/TanStack/query/blob/main/packages/query-core/src/subscribable.ts#L27) + +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()`. #### Parameters @@ -319,6 +325,8 @@ Defined in: [packages/query-core/src/subscribable.ts:8](https://github.com/TanSt `MutationCacheListener` +Called on each update, with whatever the subclass passes to its subscribers. + #### Returns ```ts @@ -329,6 +337,16 @@ Defined in: [packages/query-core/src/subscribable.ts:8](https://github.com/TanSt `void` +#### Example + +```ts +const unsubscribe = subscribable.subscribe(() => { + // react to the update +}) + +unsubscribe() +``` + #### Inherited from ```ts diff --git a/docs/framework/vue/reference/classes/MutationObserver.md b/docs/framework/vue/reference/classes/MutationObserver.md index b0a5f850b74..769317ddfd2 100644 --- a/docs/framework/vue/reference/classes/MutationObserver.md +++ b/docs/framework/vue/reference/classes/MutationObserver.md @@ -82,7 +82,7 @@ Subscribable< protected listeners: Set>; ``` -Defined in: [packages/query-core/src/subscribable.ts:2](https://github.com/TanStack/query/blob/main/packages/query-core/src/subscribable.ts#L2) +Defined in: [packages/query-core/src/subscribable.ts:7](https://github.com/TanStack/query/blob/main/packages/query-core/src/subscribable.ts#L7) #### Inherited from @@ -140,7 +140,9 @@ built yet, e.g. before the first `mutate()` call or after `reset()`). hasListeners(): boolean; ``` -Defined in: [packages/query-core/src/subscribable.ts:19](https://github.com/TanStack/query/blob/main/packages/query-core/src/subscribable.ts#L19) +Defined in: [packages/query-core/src/subscribable.ts:41](https://github.com/TanStack/query/blob/main/packages/query-core/src/subscribable.ts#L41) + +Returns `true` while at least one listener is registered, `false` once they have all unsubscribed. #### Returns @@ -310,7 +312,11 @@ observer.setOptions({ subscribe(listener: MutationObserverListener): () => void; ``` -Defined in: [packages/query-core/src/subscribable.ts:8](https://github.com/TanStack/query/blob/main/packages/query-core/src/subscribable.ts#L8) +Defined in: [packages/query-core/src/subscribable.ts:27](https://github.com/TanStack/query/blob/main/packages/query-core/src/subscribable.ts#L27) + +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()`. #### Parameters @@ -318,6 +324,8 @@ Defined in: [packages/query-core/src/subscribable.ts:8](https://github.com/TanSt `MutationObserverListener` +Called on each update, with whatever the subclass passes to its subscribers. + #### Returns ```ts @@ -328,6 +336,16 @@ Defined in: [packages/query-core/src/subscribable.ts:8](https://github.com/TanSt `void` +#### Example + +```ts +const unsubscribe = subscribable.subscribe(() => { + // react to the update +}) + +unsubscribe() +``` + #### Inherited from ```ts diff --git a/docs/framework/vue/reference/classes/QueriesObserver.md b/docs/framework/vue/reference/classes/QueriesObserver.md index a8fdea14666..2b500664849 100644 --- a/docs/framework/vue/reference/classes/QueriesObserver.md +++ b/docs/framework/vue/reference/classes/QueriesObserver.md @@ -79,7 +79,7 @@ Subscribable.constructor protected listeners: Set; ``` -Defined in: [packages/query-core/src/subscribable.ts:2](https://github.com/TanStack/query/blob/main/packages/query-core/src/subscribable.ts#L2) +Defined in: [packages/query-core/src/subscribable.ts:7](https://github.com/TanStack/query/blob/main/packages/query-core/src/subscribable.ts#L7) #### Inherited from @@ -202,7 +202,9 @@ the same order as the queries passed to the constructor or `setQueries`. hasListeners(): boolean; ``` -Defined in: [packages/query-core/src/subscribable.ts:19](https://github.com/TanStack/query/blob/main/packages/query-core/src/subscribable.ts#L19) +Defined in: [packages/query-core/src/subscribable.ts:41](https://github.com/TanStack/query/blob/main/packages/query-core/src/subscribable.ts#L41) + +Returns `true` while at least one listener is registered, `false` once they have all unsubscribed. #### Returns @@ -300,7 +302,11 @@ observer.setQueries([ subscribe(listener: QueriesObserverListener): () => void; ``` -Defined in: [packages/query-core/src/subscribable.ts:8](https://github.com/TanStack/query/blob/main/packages/query-core/src/subscribable.ts#L8) +Defined in: [packages/query-core/src/subscribable.ts:27](https://github.com/TanStack/query/blob/main/packages/query-core/src/subscribable.ts#L27) + +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()`. #### Parameters @@ -308,6 +314,8 @@ Defined in: [packages/query-core/src/subscribable.ts:8](https://github.com/TanSt `QueriesObserverListener` +Called on each update, with whatever the subclass passes to its subscribers. + #### Returns ```ts @@ -318,6 +326,16 @@ Defined in: [packages/query-core/src/subscribable.ts:8](https://github.com/TanSt `void` +#### Example + +```ts +const unsubscribe = subscribable.subscribe(() => { + // react to the update +}) + +unsubscribe() +``` + #### Inherited from ```ts diff --git a/docs/framework/vue/reference/classes/Query.md b/docs/framework/vue/reference/classes/Query.md index a996eb21a15..eca90a14360 100644 --- a/docs/framework/vue/reference/classes/Query.md +++ b/docs/framework/vue/reference/classes/Query.md @@ -80,7 +80,7 @@ Removable.constructor gcTime: number; ``` -Defined in: [packages/query-core/src/removable.ts:7](https://github.com/TanStack/query/blob/main/packages/query-core/src/removable.ts#L7) +Defined in: [packages/query-core/src/removable.ts:11](https://github.com/TanStack/query/blob/main/packages/query-core/src/removable.ts#L11) #### Inherited from @@ -213,7 +213,7 @@ await query.cancel() protected clearGcTimeout(): void; ``` -Defined in: [packages/query-core/src/removable.ts:32](https://github.com/TanStack/query/blob/main/packages/query-core/src/removable.ts#L32) +Defined in: [packages/query-core/src/removable.ts:41](https://github.com/TanStack/query/blob/main/packages/query-core/src/removable.ts#L41) #### Returns @@ -522,7 +522,7 @@ in-flight fetch. protected scheduleGc(): void; ``` -Defined in: [packages/query-core/src/removable.ts:14](https://github.com/TanStack/query/blob/main/packages/query-core/src/removable.ts#L14) +Defined in: [packages/query-core/src/removable.ts:23](https://github.com/TanStack/query/blob/main/packages/query-core/src/removable.ts#L23) #### Returns @@ -566,7 +566,7 @@ user manually trigger a loading/error state or edit the cached data. protected updateGcTime(newGcTime: number | undefined): void; ``` -Defined in: [packages/query-core/src/removable.ts:24](https://github.com/TanStack/query/blob/main/packages/query-core/src/removable.ts#L24) +Defined in: [packages/query-core/src/removable.ts:33](https://github.com/TanStack/query/blob/main/packages/query-core/src/removable.ts#L33) #### Parameters diff --git a/docs/framework/vue/reference/classes/QueryCache.md b/docs/framework/vue/reference/classes/QueryCache.md index ad4911294b8..dd521fe4bd8 100644 --- a/docs/framework/vue/reference/classes/QueryCache.md +++ b/docs/framework/vue/reference/classes/QueryCache.md @@ -63,7 +63,7 @@ QC.config protected listeners: Set; ``` -Defined in: [packages/query-core/src/subscribable.ts:2](https://github.com/TanStack/query/blob/main/packages/query-core/src/subscribable.ts#L2) +Defined in: [packages/query-core/src/subscribable.ts:7](https://github.com/TanStack/query/blob/main/packages/query-core/src/subscribable.ts#L7) #### Inherited from @@ -379,7 +379,9 @@ QC.getAll hasListeners(): boolean; ``` -Defined in: [packages/query-core/src/subscribable.ts:19](https://github.com/TanStack/query/blob/main/packages/query-core/src/subscribable.ts#L19) +Defined in: [packages/query-core/src/subscribable.ts:41](https://github.com/TanStack/query/blob/main/packages/query-core/src/subscribable.ts#L41) + +Returns `true` while at least one listener is registered, `false` once they have all unsubscribed. #### Returns @@ -399,7 +401,7 @@ QC.hasListeners protected onSubscribe(): void; ``` -Defined in: [packages/query-core/src/subscribable.ts:23](https://github.com/TanStack/query/blob/main/packages/query-core/src/subscribable.ts#L23) +Defined in: [packages/query-core/src/subscribable.ts:45](https://github.com/TanStack/query/blob/main/packages/query-core/src/subscribable.ts#L45) #### Returns @@ -419,7 +421,7 @@ QC.onSubscribe protected onUnsubscribe(): void; ``` -Defined in: [packages/query-core/src/subscribable.ts:27](https://github.com/TanStack/query/blob/main/packages/query-core/src/subscribable.ts#L27) +Defined in: [packages/query-core/src/subscribable.ts:49](https://github.com/TanStack/query/blob/main/packages/query-core/src/subscribable.ts#L49) #### Returns @@ -481,7 +483,11 @@ QC.remove subscribe(listener: QueryCacheListener): () => void; ``` -Defined in: [packages/query-core/src/subscribable.ts:8](https://github.com/TanStack/query/blob/main/packages/query-core/src/subscribable.ts#L8) +Defined in: [packages/query-core/src/subscribable.ts:27](https://github.com/TanStack/query/blob/main/packages/query-core/src/subscribable.ts#L27) + +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()`. #### Parameters @@ -489,6 +495,8 @@ Defined in: [packages/query-core/src/subscribable.ts:8](https://github.com/TanSt `QueryCacheListener` +Called on each update, with whatever the subclass passes to its subscribers. + #### Returns ```ts @@ -499,6 +507,16 @@ Defined in: [packages/query-core/src/subscribable.ts:8](https://github.com/TanSt `void` +#### Example + +```ts +const unsubscribe = subscribable.subscribe(() => { + // react to the update +}) + +unsubscribe() +``` + #### Inherited from ```ts diff --git a/docs/framework/vue/reference/classes/QueryObserver.md b/docs/framework/vue/reference/classes/QueryObserver.md index 891331d2cb5..354c5a9494e 100644 --- a/docs/framework/vue/reference/classes/QueryObserver.md +++ b/docs/framework/vue/reference/classes/QueryObserver.md @@ -93,7 +93,7 @@ Subscribable>.constructor protected listeners: Set>; ``` -Defined in: [packages/query-core/src/subscribable.ts:2](https://github.com/TanStack/query/blob/main/packages/query-core/src/subscribable.ts#L2) +Defined in: [packages/query-core/src/subscribable.ts:7](https://github.com/TanStack/query/blob/main/packages/query-core/src/subscribable.ts#L7) #### Inherited from @@ -298,7 +298,9 @@ returned value is available synchronously, ahead of `setOptions` triggering an a hasListeners(): boolean; ``` -Defined in: [packages/query-core/src/subscribable.ts:19](https://github.com/TanStack/query/blob/main/packages/query-core/src/subscribable.ts#L19) +Defined in: [packages/query-core/src/subscribable.ts:41](https://github.com/TanStack/query/blob/main/packages/query-core/src/subscribable.ts#L41) + +Returns `true` while at least one listener is registered, `false` once they have all unsubscribed. #### Returns @@ -458,7 +460,11 @@ regains focus. subscribe(listener: QueryObserverListener): () => void; ``` -Defined in: [packages/query-core/src/subscribable.ts:8](https://github.com/TanStack/query/blob/main/packages/query-core/src/subscribable.ts#L8) +Defined in: [packages/query-core/src/subscribable.ts:27](https://github.com/TanStack/query/blob/main/packages/query-core/src/subscribable.ts#L27) + +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()`. #### Parameters @@ -466,6 +472,8 @@ Defined in: [packages/query-core/src/subscribable.ts:8](https://github.com/TanSt `QueryObserverListener` +Called on each update, with whatever the subclass passes to its subscribers. + #### Returns ```ts @@ -476,6 +484,16 @@ Defined in: [packages/query-core/src/subscribable.ts:8](https://github.com/TanSt `void` +#### Example + +```ts +const unsubscribe = subscribable.subscribe(() => { + // react to the update +}) + +unsubscribe() +``` + #### Inherited from ```ts diff --git a/docs/framework/vue/reference/interfaces/FocusManager.md b/docs/framework/vue/reference/interfaces/FocusManager.md index 63e0813388a..c0e6c1dcf22 100644 --- a/docs/framework/vue/reference/interfaces/FocusManager.md +++ b/docs/framework/vue/reference/interfaces/FocusManager.md @@ -27,7 +27,9 @@ It can be used to change the default event listeners or to manually change the f hasListeners(): boolean; ``` -Defined in: [packages/query-core/src/subscribable.ts:19](https://github.com/TanStack/query/blob/main/packages/query-core/src/subscribable.ts#L19) +Defined in: [packages/query-core/src/subscribable.ts:41](https://github.com/TanStack/query/blob/main/packages/query-core/src/subscribable.ts#L41) + +Returns `true` while at least one listener is registered, `false` once they have all unsubscribed. #### Returns @@ -202,7 +204,11 @@ focusManager.setFocused(undefined) subscribe(listener: Listener): () => void; ``` -Defined in: [packages/query-core/src/subscribable.ts:8](https://github.com/TanStack/query/blob/main/packages/query-core/src/subscribable.ts#L8) +Defined in: [packages/query-core/src/subscribable.ts:27](https://github.com/TanStack/query/blob/main/packages/query-core/src/subscribable.ts#L27) + +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()`. #### Parameters @@ -210,6 +216,8 @@ Defined in: [packages/query-core/src/subscribable.ts:8](https://github.com/TanSt `Listener` +Called on each update, with whatever the subclass passes to its subscribers. + #### Returns ```ts @@ -220,6 +228,16 @@ Defined in: [packages/query-core/src/subscribable.ts:8](https://github.com/TanSt `void` +#### Example + +```ts +const unsubscribe = subscribable.subscribe(() => { + // react to the update +}) + +unsubscribe() +``` + #### Inherited from ```ts diff --git a/docs/framework/vue/reference/interfaces/OnlineManager.md b/docs/framework/vue/reference/interfaces/OnlineManager.md index 6f0f71074db..e9f911fce4e 100644 --- a/docs/framework/vue/reference/interfaces/OnlineManager.md +++ b/docs/framework/vue/reference/interfaces/OnlineManager.md @@ -31,7 +31,9 @@ detect changes. hasListeners(): boolean; ``` -Defined in: [packages/query-core/src/subscribable.ts:19](https://github.com/TanStack/query/blob/main/packages/query-core/src/subscribable.ts#L19) +Defined in: [packages/query-core/src/subscribable.ts:41](https://github.com/TanStack/query/blob/main/packages/query-core/src/subscribable.ts#L41) + +Returns `true` while at least one listener is registered, `false` once they have all unsubscribed. #### Returns @@ -179,7 +181,11 @@ onlineManager.setOnline(false) subscribe(listener: Listener): () => void; ``` -Defined in: [packages/query-core/src/subscribable.ts:8](https://github.com/TanStack/query/blob/main/packages/query-core/src/subscribable.ts#L8) +Defined in: [packages/query-core/src/subscribable.ts:27](https://github.com/TanStack/query/blob/main/packages/query-core/src/subscribable.ts#L27) + +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()`. #### Parameters @@ -187,6 +193,8 @@ Defined in: [packages/query-core/src/subscribable.ts:8](https://github.com/TanSt `Listener` +Called on each update, with whatever the subclass passes to its subscribers. + #### Returns ```ts @@ -197,6 +205,16 @@ Defined in: [packages/query-core/src/subscribable.ts:8](https://github.com/TanSt `void` +#### Example + +```ts +const unsubscribe = subscribable.subscribe(() => { + // react to the update +}) + +unsubscribe() +``` + #### Inherited from ```ts diff --git a/packages/query-core/src/removable.ts b/packages/query-core/src/removable.ts index 4e84ee62060..e987b84555f 100644 --- a/packages/query-core/src/removable.ts +++ b/packages/query-core/src/removable.ts @@ -3,10 +3,19 @@ import { isServer as isServerEnvironment } from './environmentManager' import { isValidTimeout } from './utils' import type { ManagedTimerId } from './timeoutManager' +/** + * The base class for cache entries that are garbage collected once nothing is using them — + * `Query` and `Mutation` both extend it. `gcTime` controls how long an unused entry is kept. + */ export abstract class Removable { gcTime!: number #gcTimeout?: ManagedTimerId + /** + * Clears the pending garbage collection timeout, so the entry is no longer scheduled for removal. + * A subclass may override this to release what it holds on to as well — `Query` also cancels any + * in-flight fetch. + */ destroy(): void { this.clearGcTimeout() } diff --git a/packages/query-core/src/subscribable.ts b/packages/query-core/src/subscribable.ts index 044efe64720..a2cab96b7b4 100644 --- a/packages/query-core/src/subscribable.ts +++ b/packages/query-core/src/subscribable.ts @@ -1,3 +1,8 @@ +/** + * The base class behind everything in Query that you can subscribe to: `QueryCache`, `MutationCache`, + * the observers, and the `FocusManager`/`OnlineManager` behind `focusManager` and `onlineManager`. + * Subclasses decide what a listener receives and when it is called. + */ export class Subscribable { protected listeners = new Set() @@ -5,6 +10,20 @@ export class Subscribable { this.subscribe = this.subscribe.bind(this) } + /** + * 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 - Called on each update, with whatever the subclass passes to its subscribers. + * @example + * ```ts + * const unsubscribe = subscribable.subscribe(() => { + * // react to the update + * }) + * + * unsubscribe() + * ``` + */ subscribe(listener: TListener): () => void { this.listeners.add(listener) @@ -16,6 +35,9 @@ export class Subscribable { } } + /** + * Returns `true` while at least one listener is registered, `false` once they have all unsubscribed. + */ hasListeners(): boolean { return this.listeners.size > 0 }