From 53bf4d38f0cff75450f3467ae1290c55ac8de8d1 Mon Sep 17 00:00:00 2001 From: Wonsuk Choi Date: Mon, 21 Sep 2026 12:32:46 +0900 Subject: [PATCH] docs(*): exclude protected members from generated reference docs --- .../classes/InfiniteQueryObserver.md | 112 ----------------- .../angular/reference/classes/Mutation.md | 86 ------------- .../reference/classes/MutationCache.md | 56 --------- .../reference/classes/MutationObserver.md | 70 ----------- .../reference/classes/QueriesObserver.md | 56 --------- .../angular/reference/classes/Query.md | 86 ------------- .../angular/reference/classes/QueryCache.md | 56 --------- .../reference/classes/QueryObserver.md | 114 ------------------ .../reference/interfaces/FocusManager.md | 46 ------- .../reference/interfaces/OnlineManager.md | 46 ------- .../classes/InfiniteQueryObserver.md | 112 ----------------- .../lit/reference/classes/Mutation.md | 86 ------------- .../lit/reference/classes/MutationCache.md | 56 --------- .../lit/reference/classes/MutationObserver.md | 70 ----------- .../lit/reference/classes/QueriesObserver.md | 56 --------- docs/framework/lit/reference/classes/Query.md | 86 ------------- .../lit/reference/classes/QueryCache.md | 56 --------- .../lit/reference/classes/QueryObserver.md | 114 ------------------ .../lit/reference/interfaces/FocusManager.md | 46 ------- .../lit/reference/interfaces/OnlineManager.md | 46 ------- .../classes/InfiniteQueryObserver.md | 112 ----------------- .../preact/reference/classes/Mutation.md | 86 ------------- .../preact/reference/classes/MutationCache.md | 56 --------- .../reference/classes/MutationObserver.md | 70 ----------- .../reference/classes/QueriesObserver.md | 56 --------- .../preact/reference/classes/Query.md | 86 ------------- .../preact/reference/classes/QueryCache.md | 56 --------- .../preact/reference/classes/QueryObserver.md | 114 ------------------ .../reference/interfaces/FocusManager.md | 46 ------- .../reference/interfaces/OnlineManager.md | 46 ------- .../classes/InfiniteQueryObserver.md | 112 ----------------- .../react/reference/classes/Mutation.md | 86 ------------- .../react/reference/classes/MutationCache.md | 56 --------- .../reference/classes/MutationObserver.md | 70 ----------- .../reference/classes/QueriesObserver.md | 56 --------- .../react/reference/classes/Query.md | 86 ------------- .../react/reference/classes/QueryCache.md | 56 --------- .../react/reference/classes/QueryObserver.md | 114 ------------------ .../reference/interfaces/FocusManager.md | 46 ------- .../reference/interfaces/OnlineManager.md | 46 ------- .../classes/InfiniteQueryObserver.md | 112 ----------------- .../solid/reference/classes/Mutation.md | 86 ------------- .../solid/reference/classes/MutationCache.md | 56 --------- .../reference/classes/MutationObserver.md | 70 ----------- .../reference/classes/QueriesObserver.md | 56 --------- .../solid/reference/classes/Query.md | 86 ------------- .../solid/reference/classes/QueryCache.md | 56 --------- .../solid/reference/classes/QueryObserver.md | 114 ------------------ .../reference/interfaces/FocusManager.md | 46 ------- .../reference/interfaces/OnlineManager.md | 46 ------- .../classes/InfiniteQueryObserver.md | 112 ----------------- .../svelte/reference/classes/Mutation.md | 86 ------------- .../svelte/reference/classes/MutationCache.md | 56 --------- .../reference/classes/MutationObserver.md | 70 ----------- .../reference/classes/QueriesObserver.md | 56 --------- .../svelte/reference/classes/Query.md | 86 ------------- .../svelte/reference/classes/QueryCache.md | 56 --------- .../svelte/reference/classes/QueryObserver.md | 114 ------------------ .../reference/interfaces/FocusManager.md | 46 ------- .../reference/interfaces/OnlineManager.md | 46 ------- .../classes/InfiniteQueryObserver.md | 112 ----------------- .../vue/reference/classes/Mutation.md | 86 ------------- .../vue/reference/classes/MutationCache.md | 56 --------- .../vue/reference/classes/MutationObserver.md | 70 ----------- .../vue/reference/classes/QueriesObserver.md | 56 --------- docs/framework/vue/reference/classes/Query.md | 86 ------------- .../vue/reference/classes/QueryCache.md | 56 --------- .../vue/reference/classes/QueryObserver.md | 114 ------------------ .../vue/reference/interfaces/FocusManager.md | 46 ------- .../vue/reference/interfaces/OnlineManager.md | 46 ------- scripts/generate-docs.ts | 1 + 71 files changed, 1 insertion(+), 5096 deletions(-) diff --git a/docs/framework/angular/reference/classes/InfiniteQueryObserver.md b/docs/framework/angular/reference/classes/InfiniteQueryObserver.md index 0fc1765d488..933d392b3fd 100644 --- a/docs/framework/angular/reference/classes/InfiniteQueryObserver.md +++ b/docs/framework/angular/reference/classes/InfiniteQueryObserver.md @@ -80,22 +80,6 @@ Defined in: [packages/query-core/src/infiniteQueryObserver.ts:83](https://github ## Properties -### fetch - -```ts -protected fetch: ReplaceReturnType<(fetchOptions: ObserverFetchOptions) => Promise>, Promise>>; -``` - -Defined in: [packages/query-core/src/infiniteQueryObserver.ts:72](https://github.com/TanStack/query/blob/main/packages/query-core/src/infiniteQueryObserver.ts#L72) - -#### Overrides - -```ts -QueryObserver.fetch -``` - -*** - ### getCurrentResult ```ts @@ -124,20 +108,6 @@ QueryObserver.getCurrentResult *** -### listeners - -```ts -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) - -#### Inherited from - -[`QueryObserver`](QueryObserver.md).[`listeners`](QueryObserver.md#listeners) - -*** - ### options ```ts @@ -184,52 +154,6 @@ QueryObserver.subscribe ## Methods -### bindMethods() - -```ts -protected bindMethods(): void; -``` - -Defined in: [packages/query-core/src/infiniteQueryObserver.ts:96](https://github.com/TanStack/query/blob/main/packages/query-core/src/infiniteQueryObserver.ts#L96) - -#### Returns - -`void` - -#### Overrides - -[`QueryObserver`](QueryObserver.md).[`bindMethods`](QueryObserver.md#bindmethods) - -*** - -### createResult() - -```ts -protected createResult(query: Query, TQueryKey>, options: InfiniteQueryObserverOptions): InfiniteQueryObserverResult; -``` - -Defined in: [packages/query-core/src/infiniteQueryObserver.ts:201](https://github.com/TanStack/query/blob/main/packages/query-core/src/infiniteQueryObserver.ts#L201) - -#### Parameters - -##### query - -[`Query`](Query.md)\<`TQueryFnData`, `TError`, [`InfiniteData`](../interfaces/InfiniteData.md)\<`TQueryFnData`, `TPageParam`\>, `TQueryKey`\> - -##### options - -[`InfiniteQueryObserverOptions`](../interfaces/InfiniteQueryObserverOptions.md)\<`TQueryFnData`, `TError`, `TData`, `TQueryKey`, `TPageParam`\> - -#### Returns - -[`InfiniteQueryObserverResult`](../type-aliases/InfiniteQueryObserverResult.md)\<`TData`, `TError`\> - -#### Overrides - -[`QueryObserver`](QueryObserver.md).[`createResult`](QueryObserver.md#createresult) - -*** - ### destroy() ```ts @@ -439,42 +363,6 @@ Defined in: [packages/query-core/src/subscribable.ts:19](https://github.com/TanS *** -### onSubscribe() - -```ts -protected onSubscribe(): void; -``` - -Defined in: [packages/query-core/src/queryObserver.ts:110](https://github.com/TanStack/query/blob/main/packages/query-core/src/queryObserver.ts#L110) - -#### Returns - -`void` - -#### Inherited from - -[`QueryObserver`](QueryObserver.md).[`onSubscribe`](QueryObserver.md#onsubscribe) - -*** - -### onUnsubscribe() - -```ts -protected onUnsubscribe(): void; -``` - -Defined in: [packages/query-core/src/queryObserver.ts:124](https://github.com/TanStack/query/blob/main/packages/query-core/src/queryObserver.ts#L124) - -#### Returns - -`void` - -#### Inherited from - -[`QueryObserver`](QueryObserver.md).[`onUnsubscribe`](QueryObserver.md#onunsubscribe) - -*** - ### refetch() ```ts diff --git a/docs/framework/angular/reference/classes/Mutation.md b/docs/framework/angular/reference/classes/Mutation.md index fa3b9c79522..c1fc2ce5591 100644 --- a/docs/framework/angular/reference/classes/Mutation.md +++ b/docs/framework/angular/reference/classes/Mutation.md @@ -136,26 +136,6 @@ The `meta` object passed in the mutation's options, if any. ## Methods -### clearGcTimeout() - -```ts -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) - -#### Returns - -`void` - -#### Inherited from - -```ts -Removable.clearGcTimeout -``` - -*** - ### continue() ```ts @@ -262,69 +242,3 @@ const data = await mutation.execute(variables) #### See [Mutation#continue](#continue) - -*** - -### optionalRemove() - -```ts -protected optionalRemove(): void; -``` - -Defined in: [packages/query-core/src/mutation.ts:212](https://github.com/TanStack/query/blob/main/packages/query-core/src/mutation.ts#L212) - -#### Returns - -`void` - -#### Overrides - -```ts -Removable.optionalRemove -``` - -*** - -### scheduleGc() - -```ts -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) - -#### Returns - -`void` - -#### Inherited from - -```ts -Removable.scheduleGc -``` - -*** - -### updateGcTime() - -```ts -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) - -#### Parameters - -##### newGcTime - -`number` | `undefined` - -#### Returns - -`void` - -#### Inherited from - -```ts -Removable.updateGcTime -``` diff --git a/docs/framework/angular/reference/classes/MutationCache.md b/docs/framework/angular/reference/classes/MutationCache.md index 65015530c74..c00fbc4a149 100644 --- a/docs/framework/angular/reference/classes/MutationCache.md +++ b/docs/framework/angular/reference/classes/MutationCache.md @@ -59,22 +59,6 @@ config: MutationCacheConfig = {}; Defined in: [packages/query-core/src/mutationCache.ts:129](https://github.com/TanStack/query/blob/main/packages/query-core/src/mutationCache.ts#L129) -*** - -### listeners - -```ts -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) - -#### Inherited from - -```ts -Subscribable.listeners -``` - ## Methods ### clear() @@ -245,46 +229,6 @@ Subscribable.hasListeners *** -### onSubscribe() - -```ts -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) - -#### Returns - -`void` - -#### Inherited from - -```ts -Subscribable.onSubscribe -``` - -*** - -### onUnsubscribe() - -```ts -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) - -#### Returns - -`void` - -#### Inherited from - -```ts -Subscribable.onUnsubscribe -``` - -*** - ### subscribe() ```ts diff --git a/docs/framework/angular/reference/classes/MutationObserver.md b/docs/framework/angular/reference/classes/MutationObserver.md index 90bac0ff994..9c9ab3a0b8e 100644 --- a/docs/framework/angular/reference/classes/MutationObserver.md +++ b/docs/framework/angular/reference/classes/MutationObserver.md @@ -76,22 +76,6 @@ Subscribable< ## Properties -### listeners - -```ts -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) - -#### Inherited from - -```ts -Subscribable.listeners -``` - -*** - ### options ```ts @@ -102,20 +86,6 @@ Defined in: [packages/query-core/src/mutationObserver.ts:46](https://github.com/ ## Methods -### bindMethods() - -```ts -protected bindMethods(): void; -``` - -Defined in: [packages/query-core/src/mutationObserver.ts:75](https://github.com/TanStack/query/blob/main/packages/query-core/src/mutationObserver.ts#L75) - -#### Returns - -`void` - -*** - ### getCurrentResult() ```ts @@ -196,46 +166,6 @@ await observer.mutate( *** -### onSubscribe() - -```ts -protected onSubscribe(): void; -``` - -Defined in: [packages/query-core/src/mutationObserver.ts:127](https://github.com/TanStack/query/blob/main/packages/query-core/src/mutationObserver.ts#L127) - -#### Returns - -`void` - -#### Overrides - -```ts -Subscribable.onSubscribe -``` - -*** - -### onUnsubscribe() - -```ts -protected onUnsubscribe(): void; -``` - -Defined in: [packages/query-core/src/mutationObserver.ts:135](https://github.com/TanStack/query/blob/main/packages/query-core/src/mutationObserver.ts#L135) - -#### Returns - -`void` - -#### Overrides - -```ts -Subscribable.onUnsubscribe -``` - -*** - ### reset() ```ts diff --git a/docs/framework/angular/reference/classes/QueriesObserver.md b/docs/framework/angular/reference/classes/QueriesObserver.md index 8bf48fdbebe..4d862779a87 100644 --- a/docs/framework/angular/reference/classes/QueriesObserver.md +++ b/docs/framework/angular/reference/classes/QueriesObserver.md @@ -71,22 +71,6 @@ Defined in: [packages/query-core/src/queriesObserver.ts:70](https://github.com/T Subscribable.constructor ``` -## Properties - -### listeners - -```ts -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) - -#### Inherited from - -```ts -Subscribable.listeners -``` - ## Methods ### destroy() @@ -216,46 +200,6 @@ Subscribable.hasListeners *** -### onSubscribe() - -```ts -protected onSubscribe(): void; -``` - -Defined in: [packages/query-core/src/queriesObserver.ts:86](https://github.com/TanStack/query/blob/main/packages/query-core/src/queriesObserver.ts#L86) - -#### Returns - -`void` - -#### Overrides - -```ts -Subscribable.onSubscribe -``` - -*** - -### onUnsubscribe() - -```ts -protected onUnsubscribe(): void; -``` - -Defined in: [packages/query-core/src/queriesObserver.ts:96](https://github.com/TanStack/query/blob/main/packages/query-core/src/queriesObserver.ts#L96) - -#### Returns - -`void` - -#### Overrides - -```ts -Subscribable.onUnsubscribe -``` - -*** - ### setQueries() ```ts diff --git a/docs/framework/angular/reference/classes/Query.md b/docs/framework/angular/reference/classes/Query.md index fee2fb07529..c2f8369bbad 100644 --- a/docs/framework/angular/reference/classes/Query.md +++ b/docs/framework/angular/reference/classes/Query.md @@ -207,26 +207,6 @@ await query.cancel() *** -### clearGcTimeout() - -```ts -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) - -#### Returns - -`void` - -#### Inherited from - -```ts -Removable.clearGcTimeout -``` - -*** - ### destroy() ```ts @@ -478,26 +458,6 @@ Returns `true` if the query has at least one observer configured with *** -### optionalRemove() - -```ts -protected optionalRemove(): void; -``` - -Defined in: [packages/query-core/src/query.ts:305](https://github.com/TanStack/query/blob/main/packages/query-core/src/query.ts#L305) - -#### Returns - -`void` - -#### Overrides - -```ts -Removable.optionalRemove -``` - -*** - ### reset() ```ts @@ -516,26 +476,6 @@ in-flight fetch. *** -### scheduleGc() - -```ts -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) - -#### Returns - -`void` - -#### Inherited from - -```ts -Removable.scheduleGc -``` - -*** - ### setState() ```ts @@ -557,29 +497,3 @@ user manually trigger a loading/error state or edit the cached data. #### Returns `void` - -*** - -### updateGcTime() - -```ts -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) - -#### Parameters - -##### newGcTime - -`number` | `undefined` - -#### Returns - -`void` - -#### Inherited from - -```ts -Removable.updateGcTime -``` diff --git a/docs/framework/angular/reference/classes/QueryCache.md b/docs/framework/angular/reference/classes/QueryCache.md index 982a6e72fb9..61b747c1de7 100644 --- a/docs/framework/angular/reference/classes/QueryCache.md +++ b/docs/framework/angular/reference/classes/QueryCache.md @@ -62,22 +62,6 @@ config: QueryCacheConfig = {}; Defined in: [packages/query-core/src/queryCache.ts:126](https://github.com/TanStack/query/blob/main/packages/query-core/src/queryCache.ts#L126) -*** - -### listeners - -```ts -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) - -#### Inherited from - -```ts -Subscribable.listeners -``` - ## Methods ### build() @@ -364,46 +348,6 @@ Subscribable.hasListeners *** -### onSubscribe() - -```ts -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) - -#### Returns - -`void` - -#### Inherited from - -```ts -Subscribable.onSubscribe -``` - -*** - -### onUnsubscribe() - -```ts -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) - -#### Returns - -`void` - -#### Inherited from - -```ts -Subscribable.onUnsubscribe -``` - -*** - ### remove() ```ts diff --git a/docs/framework/angular/reference/classes/QueryObserver.md b/docs/framework/angular/reference/classes/QueryObserver.md index 8f5dd48169e..180c2df63d6 100644 --- a/docs/framework/angular/reference/classes/QueryObserver.md +++ b/docs/framework/angular/reference/classes/QueryObserver.md @@ -87,22 +87,6 @@ Subscribable>.constructor ## Properties -### listeners - -```ts -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) - -#### Inherited from - -```ts -Subscribable.listeners -``` - -*** - ### options ```ts @@ -113,44 +97,6 @@ Defined in: [packages/query-core/src/queryObserver.ts:89](https://github.com/Tan ## Methods -### bindMethods() - -```ts -protected bindMethods(): void; -``` - -Defined in: [packages/query-core/src/queryObserver.ts:106](https://github.com/TanStack/query/blob/main/packages/query-core/src/queryObserver.ts#L106) - -#### Returns - -`void` - -*** - -### createResult() - -```ts -protected createResult(query: Query, options: QueryObserverOptions): QueryObserverResult; -``` - -Defined in: [packages/query-core/src/queryObserver.ts:559](https://github.com/TanStack/query/blob/main/packages/query-core/src/queryObserver.ts#L559) - -#### Parameters - -##### query - -[`Query`](Query.md)\<`TQueryFnData`, `TError`, `TQueryData`, `TQueryKey`\> - -##### options - -[`QueryObserverOptions`](../interfaces/QueryObserverOptions.md)\<`TQueryFnData`, `TError`, `TData`, `TQueryData`, `TQueryKey`\> - -#### Returns - -[`QueryObserverResult`](../type-aliases/QueryObserverResult.md)\<`TData`, `TError`\> - -*** - ### destroy() ```ts @@ -169,26 +115,6 @@ query it was observing. *** -### fetch() - -```ts -protected fetch(fetchOptions: ObserverFetchOptions): Promise>; -``` - -Defined in: [packages/query-core/src/queryObserver.ts:448](https://github.com/TanStack/query/blob/main/packages/query-core/src/queryObserver.ts#L448) - -#### Parameters - -##### fetchOptions - -`ObserverFetchOptions` - -#### Returns - -`Promise`\<[`QueryObserverResult`](../type-aliases/QueryObserverResult.md)\<`TData`, `TError`\>\> - -*** - ### fetchOptimistic() ```ts @@ -312,46 +238,6 @@ Subscribable.hasListeners *** -### onSubscribe() - -```ts -protected onSubscribe(): void; -``` - -Defined in: [packages/query-core/src/queryObserver.ts:110](https://github.com/TanStack/query/blob/main/packages/query-core/src/queryObserver.ts#L110) - -#### Returns - -`void` - -#### Overrides - -```ts -Subscribable.onSubscribe -``` - -*** - -### onUnsubscribe() - -```ts -protected onUnsubscribe(): void; -``` - -Defined in: [packages/query-core/src/queryObserver.ts:124](https://github.com/TanStack/query/blob/main/packages/query-core/src/queryObserver.ts#L124) - -#### Returns - -`void` - -#### Overrides - -```ts -Subscribable.onUnsubscribe -``` - -*** - ### refetch() ```ts diff --git a/docs/framework/angular/reference/interfaces/FocusManager.md b/docs/framework/angular/reference/interfaces/FocusManager.md index 63e0813388a..6865e1339fa 100644 --- a/docs/framework/angular/reference/interfaces/FocusManager.md +++ b/docs/framework/angular/reference/interfaces/FocusManager.md @@ -13,12 +13,6 @@ It can be used to change the default event listeners or to manually change the f - `Subscribable`\<`Listener`\> -## Properties - -| Property | Modifier | Type | -| ------ | ------ | ------ | -| `listeners` | `protected` | `Set`\<`Listener`\> | - ## Methods ### hasListeners() @@ -73,46 +67,6 @@ Defined in: [packages/query-core/src/focusManager.ts:118](https://github.com/Tan *** -### onSubscribe() - -```ts -protected onSubscribe(): void; -``` - -Defined in: [packages/query-core/src/focusManager.ts:39](https://github.com/TanStack/query/blob/main/packages/query-core/src/focusManager.ts#L39) - -#### Returns - -`void` - -#### Overrides - -```ts -Subscribable.onSubscribe -``` - -*** - -### onUnsubscribe() - -```ts -protected onUnsubscribe(): void; -``` - -Defined in: [packages/query-core/src/focusManager.ts:45](https://github.com/TanStack/query/blob/main/packages/query-core/src/focusManager.ts#L45) - -#### Returns - -`void` - -#### Overrides - -```ts -Subscribable.onUnsubscribe -``` - -*** - ### setEventListener() ```ts diff --git a/docs/framework/angular/reference/interfaces/OnlineManager.md b/docs/framework/angular/reference/interfaces/OnlineManager.md index 6f0f71074db..664e3795546 100644 --- a/docs/framework/angular/reference/interfaces/OnlineManager.md +++ b/docs/framework/angular/reference/interfaces/OnlineManager.md @@ -17,12 +17,6 @@ detect changes. - `Subscribable`\<`Listener`\> -## Properties - -| Property | Modifier | Type | -| ------ | ------ | ------ | -| `listeners` | `protected` | `Set`\<`Listener`\> | - ## Methods ### hasListeners() @@ -61,46 +55,6 @@ Defined in: [packages/query-core/src/onlineManager.ts:109](https://github.com/Ta *** -### onSubscribe() - -```ts -protected onSubscribe(): void; -``` - -Defined in: [packages/query-core/src/onlineManager.ts:44](https://github.com/TanStack/query/blob/main/packages/query-core/src/onlineManager.ts#L44) - -#### Returns - -`void` - -#### Overrides - -```ts -Subscribable.onSubscribe -``` - -*** - -### onUnsubscribe() - -```ts -protected onUnsubscribe(): void; -``` - -Defined in: [packages/query-core/src/onlineManager.ts:50](https://github.com/TanStack/query/blob/main/packages/query-core/src/onlineManager.ts#L50) - -#### Returns - -`void` - -#### Overrides - -```ts -Subscribable.onUnsubscribe -``` - -*** - ### setEventListener() ```ts diff --git a/docs/framework/lit/reference/classes/InfiniteQueryObserver.md b/docs/framework/lit/reference/classes/InfiniteQueryObserver.md index 9aed0a23afa..95ea6c15ad4 100644 --- a/docs/framework/lit/reference/classes/InfiniteQueryObserver.md +++ b/docs/framework/lit/reference/classes/InfiniteQueryObserver.md @@ -80,22 +80,6 @@ Defined in: [packages/query-core/src/infiniteQueryObserver.ts:83](https://github ## Properties -### fetch - -```ts -protected fetch: ReplaceReturnType<(fetchOptions: ObserverFetchOptions) => Promise>, Promise>>; -``` - -Defined in: [packages/query-core/src/infiniteQueryObserver.ts:72](https://github.com/TanStack/query/blob/main/packages/query-core/src/infiniteQueryObserver.ts#L72) - -#### Overrides - -```ts -QueryObserver.fetch -``` - -*** - ### getCurrentResult ```ts @@ -124,20 +108,6 @@ QueryObserver.getCurrentResult *** -### listeners - -```ts -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) - -#### Inherited from - -[`QueryObserver`](QueryObserver.md).[`listeners`](QueryObserver.md#listeners) - -*** - ### options ```ts @@ -184,52 +154,6 @@ QueryObserver.subscribe ## Methods -### bindMethods() - -```ts -protected bindMethods(): void; -``` - -Defined in: [packages/query-core/src/infiniteQueryObserver.ts:96](https://github.com/TanStack/query/blob/main/packages/query-core/src/infiniteQueryObserver.ts#L96) - -#### Returns - -`void` - -#### Overrides - -[`QueryObserver`](QueryObserver.md).[`bindMethods`](QueryObserver.md#bindmethods) - -*** - -### createResult() - -```ts -protected createResult(query: Query, TQueryKey>, options: InfiniteQueryObserverOptions): InfiniteQueryObserverResult; -``` - -Defined in: [packages/query-core/src/infiniteQueryObserver.ts:201](https://github.com/TanStack/query/blob/main/packages/query-core/src/infiniteQueryObserver.ts#L201) - -#### Parameters - -##### query - -[`Query`](Query.md)\<`TQueryFnData`, `TError`, [`InfiniteData`](../interfaces/InfiniteData.md)\<`TQueryFnData`, `TPageParam`\>, `TQueryKey`\> - -##### options - -[`InfiniteQueryObserverOptions`](../interfaces/InfiniteQueryObserverOptions.md)\<`TQueryFnData`, `TError`, `TData`, `TQueryKey`, `TPageParam`\> - -#### Returns - -[`InfiniteQueryObserverResult`](../type-aliases/InfiniteQueryObserverResult.md)\<`TData`, `TError`\> - -#### Overrides - -[`QueryObserver`](QueryObserver.md).[`createResult`](QueryObserver.md#createresult) - -*** - ### destroy() ```ts @@ -439,42 +363,6 @@ Defined in: [packages/query-core/src/subscribable.ts:19](https://github.com/TanS *** -### onSubscribe() - -```ts -protected onSubscribe(): void; -``` - -Defined in: [packages/query-core/src/queryObserver.ts:110](https://github.com/TanStack/query/blob/main/packages/query-core/src/queryObserver.ts#L110) - -#### Returns - -`void` - -#### Inherited from - -[`QueryObserver`](QueryObserver.md).[`onSubscribe`](QueryObserver.md#onsubscribe) - -*** - -### onUnsubscribe() - -```ts -protected onUnsubscribe(): void; -``` - -Defined in: [packages/query-core/src/queryObserver.ts:124](https://github.com/TanStack/query/blob/main/packages/query-core/src/queryObserver.ts#L124) - -#### Returns - -`void` - -#### Inherited from - -[`QueryObserver`](QueryObserver.md).[`onUnsubscribe`](QueryObserver.md#onunsubscribe) - -*** - ### refetch() ```ts diff --git a/docs/framework/lit/reference/classes/Mutation.md b/docs/framework/lit/reference/classes/Mutation.md index fa3b9c79522..c1fc2ce5591 100644 --- a/docs/framework/lit/reference/classes/Mutation.md +++ b/docs/framework/lit/reference/classes/Mutation.md @@ -136,26 +136,6 @@ The `meta` object passed in the mutation's options, if any. ## Methods -### clearGcTimeout() - -```ts -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) - -#### Returns - -`void` - -#### Inherited from - -```ts -Removable.clearGcTimeout -``` - -*** - ### continue() ```ts @@ -262,69 +242,3 @@ const data = await mutation.execute(variables) #### See [Mutation#continue](#continue) - -*** - -### optionalRemove() - -```ts -protected optionalRemove(): void; -``` - -Defined in: [packages/query-core/src/mutation.ts:212](https://github.com/TanStack/query/blob/main/packages/query-core/src/mutation.ts#L212) - -#### Returns - -`void` - -#### Overrides - -```ts -Removable.optionalRemove -``` - -*** - -### scheduleGc() - -```ts -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) - -#### Returns - -`void` - -#### Inherited from - -```ts -Removable.scheduleGc -``` - -*** - -### updateGcTime() - -```ts -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) - -#### Parameters - -##### newGcTime - -`number` | `undefined` - -#### Returns - -`void` - -#### Inherited from - -```ts -Removable.updateGcTime -``` diff --git a/docs/framework/lit/reference/classes/MutationCache.md b/docs/framework/lit/reference/classes/MutationCache.md index 4b193f45424..1e15a46c54b 100644 --- a/docs/framework/lit/reference/classes/MutationCache.md +++ b/docs/framework/lit/reference/classes/MutationCache.md @@ -59,22 +59,6 @@ config: MutationCacheConfig = {}; Defined in: [packages/query-core/src/mutationCache.ts:129](https://github.com/TanStack/query/blob/main/packages/query-core/src/mutationCache.ts#L129) -*** - -### listeners - -```ts -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) - -#### Inherited from - -```ts -Subscribable.listeners -``` - ## Methods ### clear() @@ -245,46 +229,6 @@ Subscribable.hasListeners *** -### onSubscribe() - -```ts -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) - -#### Returns - -`void` - -#### Inherited from - -```ts -Subscribable.onSubscribe -``` - -*** - -### onUnsubscribe() - -```ts -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) - -#### Returns - -`void` - -#### Inherited from - -```ts -Subscribable.onUnsubscribe -``` - -*** - ### subscribe() ```ts diff --git a/docs/framework/lit/reference/classes/MutationObserver.md b/docs/framework/lit/reference/classes/MutationObserver.md index 90bac0ff994..9c9ab3a0b8e 100644 --- a/docs/framework/lit/reference/classes/MutationObserver.md +++ b/docs/framework/lit/reference/classes/MutationObserver.md @@ -76,22 +76,6 @@ Subscribable< ## Properties -### listeners - -```ts -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) - -#### Inherited from - -```ts -Subscribable.listeners -``` - -*** - ### options ```ts @@ -102,20 +86,6 @@ Defined in: [packages/query-core/src/mutationObserver.ts:46](https://github.com/ ## Methods -### bindMethods() - -```ts -protected bindMethods(): void; -``` - -Defined in: [packages/query-core/src/mutationObserver.ts:75](https://github.com/TanStack/query/blob/main/packages/query-core/src/mutationObserver.ts#L75) - -#### Returns - -`void` - -*** - ### getCurrentResult() ```ts @@ -196,46 +166,6 @@ await observer.mutate( *** -### onSubscribe() - -```ts -protected onSubscribe(): void; -``` - -Defined in: [packages/query-core/src/mutationObserver.ts:127](https://github.com/TanStack/query/blob/main/packages/query-core/src/mutationObserver.ts#L127) - -#### Returns - -`void` - -#### Overrides - -```ts -Subscribable.onSubscribe -``` - -*** - -### onUnsubscribe() - -```ts -protected onUnsubscribe(): void; -``` - -Defined in: [packages/query-core/src/mutationObserver.ts:135](https://github.com/TanStack/query/blob/main/packages/query-core/src/mutationObserver.ts#L135) - -#### Returns - -`void` - -#### Overrides - -```ts -Subscribable.onUnsubscribe -``` - -*** - ### reset() ```ts diff --git a/docs/framework/lit/reference/classes/QueriesObserver.md b/docs/framework/lit/reference/classes/QueriesObserver.md index 42841eaddf8..474fc8f7725 100644 --- a/docs/framework/lit/reference/classes/QueriesObserver.md +++ b/docs/framework/lit/reference/classes/QueriesObserver.md @@ -71,22 +71,6 @@ Defined in: [packages/query-core/src/queriesObserver.ts:70](https://github.com/T Subscribable.constructor ``` -## Properties - -### listeners - -```ts -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) - -#### Inherited from - -```ts -Subscribable.listeners -``` - ## Methods ### destroy() @@ -216,46 +200,6 @@ Subscribable.hasListeners *** -### onSubscribe() - -```ts -protected onSubscribe(): void; -``` - -Defined in: [packages/query-core/src/queriesObserver.ts:86](https://github.com/TanStack/query/blob/main/packages/query-core/src/queriesObserver.ts#L86) - -#### Returns - -`void` - -#### Overrides - -```ts -Subscribable.onSubscribe -``` - -*** - -### onUnsubscribe() - -```ts -protected onUnsubscribe(): void; -``` - -Defined in: [packages/query-core/src/queriesObserver.ts:96](https://github.com/TanStack/query/blob/main/packages/query-core/src/queriesObserver.ts#L96) - -#### Returns - -`void` - -#### Overrides - -```ts -Subscribable.onUnsubscribe -``` - -*** - ### setQueries() ```ts diff --git a/docs/framework/lit/reference/classes/Query.md b/docs/framework/lit/reference/classes/Query.md index fee2fb07529..c2f8369bbad 100644 --- a/docs/framework/lit/reference/classes/Query.md +++ b/docs/framework/lit/reference/classes/Query.md @@ -207,26 +207,6 @@ await query.cancel() *** -### clearGcTimeout() - -```ts -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) - -#### Returns - -`void` - -#### Inherited from - -```ts -Removable.clearGcTimeout -``` - -*** - ### destroy() ```ts @@ -478,26 +458,6 @@ Returns `true` if the query has at least one observer configured with *** -### optionalRemove() - -```ts -protected optionalRemove(): void; -``` - -Defined in: [packages/query-core/src/query.ts:305](https://github.com/TanStack/query/blob/main/packages/query-core/src/query.ts#L305) - -#### Returns - -`void` - -#### Overrides - -```ts -Removable.optionalRemove -``` - -*** - ### reset() ```ts @@ -516,26 +476,6 @@ in-flight fetch. *** -### scheduleGc() - -```ts -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) - -#### Returns - -`void` - -#### Inherited from - -```ts -Removable.scheduleGc -``` - -*** - ### setState() ```ts @@ -557,29 +497,3 @@ user manually trigger a loading/error state or edit the cached data. #### Returns `void` - -*** - -### updateGcTime() - -```ts -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) - -#### Parameters - -##### newGcTime - -`number` | `undefined` - -#### Returns - -`void` - -#### Inherited from - -```ts -Removable.updateGcTime -``` diff --git a/docs/framework/lit/reference/classes/QueryCache.md b/docs/framework/lit/reference/classes/QueryCache.md index 2f05591bd63..15d4b9530f3 100644 --- a/docs/framework/lit/reference/classes/QueryCache.md +++ b/docs/framework/lit/reference/classes/QueryCache.md @@ -62,22 +62,6 @@ config: QueryCacheConfig = {}; Defined in: [packages/query-core/src/queryCache.ts:126](https://github.com/TanStack/query/blob/main/packages/query-core/src/queryCache.ts#L126) -*** - -### listeners - -```ts -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) - -#### Inherited from - -```ts -Subscribable.listeners -``` - ## Methods ### build() @@ -364,46 +348,6 @@ Subscribable.hasListeners *** -### onSubscribe() - -```ts -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) - -#### Returns - -`void` - -#### Inherited from - -```ts -Subscribable.onSubscribe -``` - -*** - -### onUnsubscribe() - -```ts -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) - -#### Returns - -`void` - -#### Inherited from - -```ts -Subscribable.onUnsubscribe -``` - -*** - ### remove() ```ts diff --git a/docs/framework/lit/reference/classes/QueryObserver.md b/docs/framework/lit/reference/classes/QueryObserver.md index 3cdbfaf4984..31a4deb59c2 100644 --- a/docs/framework/lit/reference/classes/QueryObserver.md +++ b/docs/framework/lit/reference/classes/QueryObserver.md @@ -87,22 +87,6 @@ Subscribable>.constructor ## Properties -### listeners - -```ts -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) - -#### Inherited from - -```ts -Subscribable.listeners -``` - -*** - ### options ```ts @@ -113,44 +97,6 @@ Defined in: [packages/query-core/src/queryObserver.ts:89](https://github.com/Tan ## Methods -### bindMethods() - -```ts -protected bindMethods(): void; -``` - -Defined in: [packages/query-core/src/queryObserver.ts:106](https://github.com/TanStack/query/blob/main/packages/query-core/src/queryObserver.ts#L106) - -#### Returns - -`void` - -*** - -### createResult() - -```ts -protected createResult(query: Query, options: QueryObserverOptions): QueryObserverResult; -``` - -Defined in: [packages/query-core/src/queryObserver.ts:559](https://github.com/TanStack/query/blob/main/packages/query-core/src/queryObserver.ts#L559) - -#### Parameters - -##### query - -[`Query`](Query.md)\<`TQueryFnData`, `TError`, `TQueryData`, `TQueryKey`\> - -##### options - -[`QueryObserverOptions`](../interfaces/QueryObserverOptions.md)\<`TQueryFnData`, `TError`, `TData`, `TQueryData`, `TQueryKey`\> - -#### Returns - -[`QueryObserverResult`](../type-aliases/QueryObserverResult.md)\<`TData`, `TError`\> - -*** - ### destroy() ```ts @@ -169,26 +115,6 @@ query it was observing. *** -### fetch() - -```ts -protected fetch(fetchOptions: ObserverFetchOptions): Promise>; -``` - -Defined in: [packages/query-core/src/queryObserver.ts:448](https://github.com/TanStack/query/blob/main/packages/query-core/src/queryObserver.ts#L448) - -#### Parameters - -##### fetchOptions - -`ObserverFetchOptions` - -#### Returns - -`Promise`\<[`QueryObserverResult`](../type-aliases/QueryObserverResult.md)\<`TData`, `TError`\>\> - -*** - ### fetchOptimistic() ```ts @@ -312,46 +238,6 @@ Subscribable.hasListeners *** -### onSubscribe() - -```ts -protected onSubscribe(): void; -``` - -Defined in: [packages/query-core/src/queryObserver.ts:110](https://github.com/TanStack/query/blob/main/packages/query-core/src/queryObserver.ts#L110) - -#### Returns - -`void` - -#### Overrides - -```ts -Subscribable.onSubscribe -``` - -*** - -### onUnsubscribe() - -```ts -protected onUnsubscribe(): void; -``` - -Defined in: [packages/query-core/src/queryObserver.ts:124](https://github.com/TanStack/query/blob/main/packages/query-core/src/queryObserver.ts#L124) - -#### Returns - -`void` - -#### Overrides - -```ts -Subscribable.onUnsubscribe -``` - -*** - ### refetch() ```ts diff --git a/docs/framework/lit/reference/interfaces/FocusManager.md b/docs/framework/lit/reference/interfaces/FocusManager.md index 63e0813388a..6865e1339fa 100644 --- a/docs/framework/lit/reference/interfaces/FocusManager.md +++ b/docs/framework/lit/reference/interfaces/FocusManager.md @@ -13,12 +13,6 @@ It can be used to change the default event listeners or to manually change the f - `Subscribable`\<`Listener`\> -## Properties - -| Property | Modifier | Type | -| ------ | ------ | ------ | -| `listeners` | `protected` | `Set`\<`Listener`\> | - ## Methods ### hasListeners() @@ -73,46 +67,6 @@ Defined in: [packages/query-core/src/focusManager.ts:118](https://github.com/Tan *** -### onSubscribe() - -```ts -protected onSubscribe(): void; -``` - -Defined in: [packages/query-core/src/focusManager.ts:39](https://github.com/TanStack/query/blob/main/packages/query-core/src/focusManager.ts#L39) - -#### Returns - -`void` - -#### Overrides - -```ts -Subscribable.onSubscribe -``` - -*** - -### onUnsubscribe() - -```ts -protected onUnsubscribe(): void; -``` - -Defined in: [packages/query-core/src/focusManager.ts:45](https://github.com/TanStack/query/blob/main/packages/query-core/src/focusManager.ts#L45) - -#### Returns - -`void` - -#### Overrides - -```ts -Subscribable.onUnsubscribe -``` - -*** - ### setEventListener() ```ts diff --git a/docs/framework/lit/reference/interfaces/OnlineManager.md b/docs/framework/lit/reference/interfaces/OnlineManager.md index 6f0f71074db..664e3795546 100644 --- a/docs/framework/lit/reference/interfaces/OnlineManager.md +++ b/docs/framework/lit/reference/interfaces/OnlineManager.md @@ -17,12 +17,6 @@ detect changes. - `Subscribable`\<`Listener`\> -## Properties - -| Property | Modifier | Type | -| ------ | ------ | ------ | -| `listeners` | `protected` | `Set`\<`Listener`\> | - ## Methods ### hasListeners() @@ -61,46 +55,6 @@ Defined in: [packages/query-core/src/onlineManager.ts:109](https://github.com/Ta *** -### onSubscribe() - -```ts -protected onSubscribe(): void; -``` - -Defined in: [packages/query-core/src/onlineManager.ts:44](https://github.com/TanStack/query/blob/main/packages/query-core/src/onlineManager.ts#L44) - -#### Returns - -`void` - -#### Overrides - -```ts -Subscribable.onSubscribe -``` - -*** - -### onUnsubscribe() - -```ts -protected onUnsubscribe(): void; -``` - -Defined in: [packages/query-core/src/onlineManager.ts:50](https://github.com/TanStack/query/blob/main/packages/query-core/src/onlineManager.ts#L50) - -#### Returns - -`void` - -#### Overrides - -```ts -Subscribable.onUnsubscribe -``` - -*** - ### setEventListener() ```ts diff --git a/docs/framework/preact/reference/classes/InfiniteQueryObserver.md b/docs/framework/preact/reference/classes/InfiniteQueryObserver.md index 0fc1765d488..933d392b3fd 100644 --- a/docs/framework/preact/reference/classes/InfiniteQueryObserver.md +++ b/docs/framework/preact/reference/classes/InfiniteQueryObserver.md @@ -80,22 +80,6 @@ Defined in: [packages/query-core/src/infiniteQueryObserver.ts:83](https://github ## Properties -### fetch - -```ts -protected fetch: ReplaceReturnType<(fetchOptions: ObserverFetchOptions) => Promise>, Promise>>; -``` - -Defined in: [packages/query-core/src/infiniteQueryObserver.ts:72](https://github.com/TanStack/query/blob/main/packages/query-core/src/infiniteQueryObserver.ts#L72) - -#### Overrides - -```ts -QueryObserver.fetch -``` - -*** - ### getCurrentResult ```ts @@ -124,20 +108,6 @@ QueryObserver.getCurrentResult *** -### listeners - -```ts -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) - -#### Inherited from - -[`QueryObserver`](QueryObserver.md).[`listeners`](QueryObserver.md#listeners) - -*** - ### options ```ts @@ -184,52 +154,6 @@ QueryObserver.subscribe ## Methods -### bindMethods() - -```ts -protected bindMethods(): void; -``` - -Defined in: [packages/query-core/src/infiniteQueryObserver.ts:96](https://github.com/TanStack/query/blob/main/packages/query-core/src/infiniteQueryObserver.ts#L96) - -#### Returns - -`void` - -#### Overrides - -[`QueryObserver`](QueryObserver.md).[`bindMethods`](QueryObserver.md#bindmethods) - -*** - -### createResult() - -```ts -protected createResult(query: Query, TQueryKey>, options: InfiniteQueryObserverOptions): InfiniteQueryObserverResult; -``` - -Defined in: [packages/query-core/src/infiniteQueryObserver.ts:201](https://github.com/TanStack/query/blob/main/packages/query-core/src/infiniteQueryObserver.ts#L201) - -#### Parameters - -##### query - -[`Query`](Query.md)\<`TQueryFnData`, `TError`, [`InfiniteData`](../interfaces/InfiniteData.md)\<`TQueryFnData`, `TPageParam`\>, `TQueryKey`\> - -##### options - -[`InfiniteQueryObserverOptions`](../interfaces/InfiniteQueryObserverOptions.md)\<`TQueryFnData`, `TError`, `TData`, `TQueryKey`, `TPageParam`\> - -#### Returns - -[`InfiniteQueryObserverResult`](../type-aliases/InfiniteQueryObserverResult.md)\<`TData`, `TError`\> - -#### Overrides - -[`QueryObserver`](QueryObserver.md).[`createResult`](QueryObserver.md#createresult) - -*** - ### destroy() ```ts @@ -439,42 +363,6 @@ Defined in: [packages/query-core/src/subscribable.ts:19](https://github.com/TanS *** -### onSubscribe() - -```ts -protected onSubscribe(): void; -``` - -Defined in: [packages/query-core/src/queryObserver.ts:110](https://github.com/TanStack/query/blob/main/packages/query-core/src/queryObserver.ts#L110) - -#### Returns - -`void` - -#### Inherited from - -[`QueryObserver`](QueryObserver.md).[`onSubscribe`](QueryObserver.md#onsubscribe) - -*** - -### onUnsubscribe() - -```ts -protected onUnsubscribe(): void; -``` - -Defined in: [packages/query-core/src/queryObserver.ts:124](https://github.com/TanStack/query/blob/main/packages/query-core/src/queryObserver.ts#L124) - -#### Returns - -`void` - -#### Inherited from - -[`QueryObserver`](QueryObserver.md).[`onUnsubscribe`](QueryObserver.md#onunsubscribe) - -*** - ### refetch() ```ts diff --git a/docs/framework/preact/reference/classes/Mutation.md b/docs/framework/preact/reference/classes/Mutation.md index fa3b9c79522..c1fc2ce5591 100644 --- a/docs/framework/preact/reference/classes/Mutation.md +++ b/docs/framework/preact/reference/classes/Mutation.md @@ -136,26 +136,6 @@ The `meta` object passed in the mutation's options, if any. ## Methods -### clearGcTimeout() - -```ts -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) - -#### Returns - -`void` - -#### Inherited from - -```ts -Removable.clearGcTimeout -``` - -*** - ### continue() ```ts @@ -262,69 +242,3 @@ const data = await mutation.execute(variables) #### See [Mutation#continue](#continue) - -*** - -### optionalRemove() - -```ts -protected optionalRemove(): void; -``` - -Defined in: [packages/query-core/src/mutation.ts:212](https://github.com/TanStack/query/blob/main/packages/query-core/src/mutation.ts#L212) - -#### Returns - -`void` - -#### Overrides - -```ts -Removable.optionalRemove -``` - -*** - -### scheduleGc() - -```ts -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) - -#### Returns - -`void` - -#### Inherited from - -```ts -Removable.scheduleGc -``` - -*** - -### updateGcTime() - -```ts -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) - -#### Parameters - -##### newGcTime - -`number` | `undefined` - -#### Returns - -`void` - -#### Inherited from - -```ts -Removable.updateGcTime -``` diff --git a/docs/framework/preact/reference/classes/MutationCache.md b/docs/framework/preact/reference/classes/MutationCache.md index 65015530c74..c00fbc4a149 100644 --- a/docs/framework/preact/reference/classes/MutationCache.md +++ b/docs/framework/preact/reference/classes/MutationCache.md @@ -59,22 +59,6 @@ config: MutationCacheConfig = {}; Defined in: [packages/query-core/src/mutationCache.ts:129](https://github.com/TanStack/query/blob/main/packages/query-core/src/mutationCache.ts#L129) -*** - -### listeners - -```ts -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) - -#### Inherited from - -```ts -Subscribable.listeners -``` - ## Methods ### clear() @@ -245,46 +229,6 @@ Subscribable.hasListeners *** -### onSubscribe() - -```ts -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) - -#### Returns - -`void` - -#### Inherited from - -```ts -Subscribable.onSubscribe -``` - -*** - -### onUnsubscribe() - -```ts -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) - -#### Returns - -`void` - -#### Inherited from - -```ts -Subscribable.onUnsubscribe -``` - -*** - ### subscribe() ```ts diff --git a/docs/framework/preact/reference/classes/MutationObserver.md b/docs/framework/preact/reference/classes/MutationObserver.md index 90bac0ff994..9c9ab3a0b8e 100644 --- a/docs/framework/preact/reference/classes/MutationObserver.md +++ b/docs/framework/preact/reference/classes/MutationObserver.md @@ -76,22 +76,6 @@ Subscribable< ## Properties -### listeners - -```ts -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) - -#### Inherited from - -```ts -Subscribable.listeners -``` - -*** - ### options ```ts @@ -102,20 +86,6 @@ Defined in: [packages/query-core/src/mutationObserver.ts:46](https://github.com/ ## Methods -### bindMethods() - -```ts -protected bindMethods(): void; -``` - -Defined in: [packages/query-core/src/mutationObserver.ts:75](https://github.com/TanStack/query/blob/main/packages/query-core/src/mutationObserver.ts#L75) - -#### Returns - -`void` - -*** - ### getCurrentResult() ```ts @@ -196,46 +166,6 @@ await observer.mutate( *** -### onSubscribe() - -```ts -protected onSubscribe(): void; -``` - -Defined in: [packages/query-core/src/mutationObserver.ts:127](https://github.com/TanStack/query/blob/main/packages/query-core/src/mutationObserver.ts#L127) - -#### Returns - -`void` - -#### Overrides - -```ts -Subscribable.onSubscribe -``` - -*** - -### onUnsubscribe() - -```ts -protected onUnsubscribe(): void; -``` - -Defined in: [packages/query-core/src/mutationObserver.ts:135](https://github.com/TanStack/query/blob/main/packages/query-core/src/mutationObserver.ts#L135) - -#### Returns - -`void` - -#### Overrides - -```ts -Subscribable.onUnsubscribe -``` - -*** - ### reset() ```ts diff --git a/docs/framework/preact/reference/classes/QueriesObserver.md b/docs/framework/preact/reference/classes/QueriesObserver.md index 8bf48fdbebe..4d862779a87 100644 --- a/docs/framework/preact/reference/classes/QueriesObserver.md +++ b/docs/framework/preact/reference/classes/QueriesObserver.md @@ -71,22 +71,6 @@ Defined in: [packages/query-core/src/queriesObserver.ts:70](https://github.com/T Subscribable.constructor ``` -## Properties - -### listeners - -```ts -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) - -#### Inherited from - -```ts -Subscribable.listeners -``` - ## Methods ### destroy() @@ -216,46 +200,6 @@ Subscribable.hasListeners *** -### onSubscribe() - -```ts -protected onSubscribe(): void; -``` - -Defined in: [packages/query-core/src/queriesObserver.ts:86](https://github.com/TanStack/query/blob/main/packages/query-core/src/queriesObserver.ts#L86) - -#### Returns - -`void` - -#### Overrides - -```ts -Subscribable.onSubscribe -``` - -*** - -### onUnsubscribe() - -```ts -protected onUnsubscribe(): void; -``` - -Defined in: [packages/query-core/src/queriesObserver.ts:96](https://github.com/TanStack/query/blob/main/packages/query-core/src/queriesObserver.ts#L96) - -#### Returns - -`void` - -#### Overrides - -```ts -Subscribable.onUnsubscribe -``` - -*** - ### setQueries() ```ts diff --git a/docs/framework/preact/reference/classes/Query.md b/docs/framework/preact/reference/classes/Query.md index fee2fb07529..c2f8369bbad 100644 --- a/docs/framework/preact/reference/classes/Query.md +++ b/docs/framework/preact/reference/classes/Query.md @@ -207,26 +207,6 @@ await query.cancel() *** -### clearGcTimeout() - -```ts -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) - -#### Returns - -`void` - -#### Inherited from - -```ts -Removable.clearGcTimeout -``` - -*** - ### destroy() ```ts @@ -478,26 +458,6 @@ Returns `true` if the query has at least one observer configured with *** -### optionalRemove() - -```ts -protected optionalRemove(): void; -``` - -Defined in: [packages/query-core/src/query.ts:305](https://github.com/TanStack/query/blob/main/packages/query-core/src/query.ts#L305) - -#### Returns - -`void` - -#### Overrides - -```ts -Removable.optionalRemove -``` - -*** - ### reset() ```ts @@ -516,26 +476,6 @@ in-flight fetch. *** -### scheduleGc() - -```ts -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) - -#### Returns - -`void` - -#### Inherited from - -```ts -Removable.scheduleGc -``` - -*** - ### setState() ```ts @@ -557,29 +497,3 @@ user manually trigger a loading/error state or edit the cached data. #### Returns `void` - -*** - -### updateGcTime() - -```ts -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) - -#### Parameters - -##### newGcTime - -`number` | `undefined` - -#### Returns - -`void` - -#### Inherited from - -```ts -Removable.updateGcTime -``` diff --git a/docs/framework/preact/reference/classes/QueryCache.md b/docs/framework/preact/reference/classes/QueryCache.md index 982a6e72fb9..61b747c1de7 100644 --- a/docs/framework/preact/reference/classes/QueryCache.md +++ b/docs/framework/preact/reference/classes/QueryCache.md @@ -62,22 +62,6 @@ config: QueryCacheConfig = {}; Defined in: [packages/query-core/src/queryCache.ts:126](https://github.com/TanStack/query/blob/main/packages/query-core/src/queryCache.ts#L126) -*** - -### listeners - -```ts -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) - -#### Inherited from - -```ts -Subscribable.listeners -``` - ## Methods ### build() @@ -364,46 +348,6 @@ Subscribable.hasListeners *** -### onSubscribe() - -```ts -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) - -#### Returns - -`void` - -#### Inherited from - -```ts -Subscribable.onSubscribe -``` - -*** - -### onUnsubscribe() - -```ts -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) - -#### Returns - -`void` - -#### Inherited from - -```ts -Subscribable.onUnsubscribe -``` - -*** - ### remove() ```ts diff --git a/docs/framework/preact/reference/classes/QueryObserver.md b/docs/framework/preact/reference/classes/QueryObserver.md index 8f5dd48169e..180c2df63d6 100644 --- a/docs/framework/preact/reference/classes/QueryObserver.md +++ b/docs/framework/preact/reference/classes/QueryObserver.md @@ -87,22 +87,6 @@ Subscribable>.constructor ## Properties -### listeners - -```ts -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) - -#### Inherited from - -```ts -Subscribable.listeners -``` - -*** - ### options ```ts @@ -113,44 +97,6 @@ Defined in: [packages/query-core/src/queryObserver.ts:89](https://github.com/Tan ## Methods -### bindMethods() - -```ts -protected bindMethods(): void; -``` - -Defined in: [packages/query-core/src/queryObserver.ts:106](https://github.com/TanStack/query/blob/main/packages/query-core/src/queryObserver.ts#L106) - -#### Returns - -`void` - -*** - -### createResult() - -```ts -protected createResult(query: Query, options: QueryObserverOptions): QueryObserverResult; -``` - -Defined in: [packages/query-core/src/queryObserver.ts:559](https://github.com/TanStack/query/blob/main/packages/query-core/src/queryObserver.ts#L559) - -#### Parameters - -##### query - -[`Query`](Query.md)\<`TQueryFnData`, `TError`, `TQueryData`, `TQueryKey`\> - -##### options - -[`QueryObserverOptions`](../interfaces/QueryObserverOptions.md)\<`TQueryFnData`, `TError`, `TData`, `TQueryData`, `TQueryKey`\> - -#### Returns - -[`QueryObserverResult`](../type-aliases/QueryObserverResult.md)\<`TData`, `TError`\> - -*** - ### destroy() ```ts @@ -169,26 +115,6 @@ query it was observing. *** -### fetch() - -```ts -protected fetch(fetchOptions: ObserverFetchOptions): Promise>; -``` - -Defined in: [packages/query-core/src/queryObserver.ts:448](https://github.com/TanStack/query/blob/main/packages/query-core/src/queryObserver.ts#L448) - -#### Parameters - -##### fetchOptions - -`ObserverFetchOptions` - -#### Returns - -`Promise`\<[`QueryObserverResult`](../type-aliases/QueryObserverResult.md)\<`TData`, `TError`\>\> - -*** - ### fetchOptimistic() ```ts @@ -312,46 +238,6 @@ Subscribable.hasListeners *** -### onSubscribe() - -```ts -protected onSubscribe(): void; -``` - -Defined in: [packages/query-core/src/queryObserver.ts:110](https://github.com/TanStack/query/blob/main/packages/query-core/src/queryObserver.ts#L110) - -#### Returns - -`void` - -#### Overrides - -```ts -Subscribable.onSubscribe -``` - -*** - -### onUnsubscribe() - -```ts -protected onUnsubscribe(): void; -``` - -Defined in: [packages/query-core/src/queryObserver.ts:124](https://github.com/TanStack/query/blob/main/packages/query-core/src/queryObserver.ts#L124) - -#### Returns - -`void` - -#### Overrides - -```ts -Subscribable.onUnsubscribe -``` - -*** - ### refetch() ```ts diff --git a/docs/framework/preact/reference/interfaces/FocusManager.md b/docs/framework/preact/reference/interfaces/FocusManager.md index 63e0813388a..6865e1339fa 100644 --- a/docs/framework/preact/reference/interfaces/FocusManager.md +++ b/docs/framework/preact/reference/interfaces/FocusManager.md @@ -13,12 +13,6 @@ It can be used to change the default event listeners or to manually change the f - `Subscribable`\<`Listener`\> -## Properties - -| Property | Modifier | Type | -| ------ | ------ | ------ | -| `listeners` | `protected` | `Set`\<`Listener`\> | - ## Methods ### hasListeners() @@ -73,46 +67,6 @@ Defined in: [packages/query-core/src/focusManager.ts:118](https://github.com/Tan *** -### onSubscribe() - -```ts -protected onSubscribe(): void; -``` - -Defined in: [packages/query-core/src/focusManager.ts:39](https://github.com/TanStack/query/blob/main/packages/query-core/src/focusManager.ts#L39) - -#### Returns - -`void` - -#### Overrides - -```ts -Subscribable.onSubscribe -``` - -*** - -### onUnsubscribe() - -```ts -protected onUnsubscribe(): void; -``` - -Defined in: [packages/query-core/src/focusManager.ts:45](https://github.com/TanStack/query/blob/main/packages/query-core/src/focusManager.ts#L45) - -#### Returns - -`void` - -#### Overrides - -```ts -Subscribable.onUnsubscribe -``` - -*** - ### setEventListener() ```ts diff --git a/docs/framework/preact/reference/interfaces/OnlineManager.md b/docs/framework/preact/reference/interfaces/OnlineManager.md index 6f0f71074db..664e3795546 100644 --- a/docs/framework/preact/reference/interfaces/OnlineManager.md +++ b/docs/framework/preact/reference/interfaces/OnlineManager.md @@ -17,12 +17,6 @@ detect changes. - `Subscribable`\<`Listener`\> -## Properties - -| Property | Modifier | Type | -| ------ | ------ | ------ | -| `listeners` | `protected` | `Set`\<`Listener`\> | - ## Methods ### hasListeners() @@ -61,46 +55,6 @@ Defined in: [packages/query-core/src/onlineManager.ts:109](https://github.com/Ta *** -### onSubscribe() - -```ts -protected onSubscribe(): void; -``` - -Defined in: [packages/query-core/src/onlineManager.ts:44](https://github.com/TanStack/query/blob/main/packages/query-core/src/onlineManager.ts#L44) - -#### Returns - -`void` - -#### Overrides - -```ts -Subscribable.onSubscribe -``` - -*** - -### onUnsubscribe() - -```ts -protected onUnsubscribe(): void; -``` - -Defined in: [packages/query-core/src/onlineManager.ts:50](https://github.com/TanStack/query/blob/main/packages/query-core/src/onlineManager.ts#L50) - -#### Returns - -`void` - -#### Overrides - -```ts -Subscribable.onUnsubscribe -``` - -*** - ### setEventListener() ```ts diff --git a/docs/framework/react/reference/classes/InfiniteQueryObserver.md b/docs/framework/react/reference/classes/InfiniteQueryObserver.md index 84a44027ee5..01c6930298c 100644 --- a/docs/framework/react/reference/classes/InfiniteQueryObserver.md +++ b/docs/framework/react/reference/classes/InfiniteQueryObserver.md @@ -83,22 +83,6 @@ Defined in: [packages/query-core/src/infiniteQueryObserver.ts:83](https://github ## Properties -### fetch - -```ts -protected fetch: ReplaceReturnType<(fetchOptions: ObserverFetchOptions) => Promise>, Promise>>; -``` - -Defined in: [packages/query-core/src/infiniteQueryObserver.ts:72](https://github.com/TanStack/query/blob/main/packages/query-core/src/infiniteQueryObserver.ts#L72) - -#### Overrides - -```ts -QueryObserver.fetch -``` - -*** - ### getCurrentResult ```ts @@ -127,20 +111,6 @@ QueryObserver.getCurrentResult *** -### listeners - -```ts -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) - -#### Inherited from - -[`QueryObserver`](QueryObserver.md).[`listeners`](QueryObserver.md#listeners) - -*** - ### options ```ts @@ -187,52 +157,6 @@ QueryObserver.subscribe ## Methods -### bindMethods() - -```ts -protected bindMethods(): void; -``` - -Defined in: [packages/query-core/src/infiniteQueryObserver.ts:96](https://github.com/TanStack/query/blob/main/packages/query-core/src/infiniteQueryObserver.ts#L96) - -#### Returns - -`void` - -#### Overrides - -[`QueryObserver`](QueryObserver.md).[`bindMethods`](QueryObserver.md#bindmethods) - -*** - -### createResult() - -```ts -protected createResult(query: Query, TQueryKey>, options: InfiniteQueryObserverOptions): InfiniteQueryObserverResult; -``` - -Defined in: [packages/query-core/src/infiniteQueryObserver.ts:201](https://github.com/TanStack/query/blob/main/packages/query-core/src/infiniteQueryObserver.ts#L201) - -#### Parameters - -##### query - -[`Query`](Query.md)\<`TQueryFnData`, `TError`, [`InfiniteData`](../interfaces/InfiniteData.md)\<`TQueryFnData`, `TPageParam`\>, `TQueryKey`\> - -##### options - -[`InfiniteQueryObserverOptions`](../interfaces/InfiniteQueryObserverOptions.md)\<`TQueryFnData`, `TError`, `TData`, `TQueryKey`, `TPageParam`\> - -#### Returns - -[`InfiniteQueryObserverResult`](../type-aliases/InfiniteQueryObserverResult.md)\<`TData`, `TError`\> - -#### Overrides - -[`QueryObserver`](QueryObserver.md).[`createResult`](QueryObserver.md#createresult) - -*** - ### destroy() ```ts @@ -442,42 +366,6 @@ Defined in: [packages/query-core/src/subscribable.ts:19](https://github.com/TanS *** -### onSubscribe() - -```ts -protected onSubscribe(): void; -``` - -Defined in: [packages/query-core/src/queryObserver.ts:110](https://github.com/TanStack/query/blob/main/packages/query-core/src/queryObserver.ts#L110) - -#### Returns - -`void` - -#### Inherited from - -[`QueryObserver`](QueryObserver.md).[`onSubscribe`](QueryObserver.md#onsubscribe) - -*** - -### onUnsubscribe() - -```ts -protected onUnsubscribe(): void; -``` - -Defined in: [packages/query-core/src/queryObserver.ts:124](https://github.com/TanStack/query/blob/main/packages/query-core/src/queryObserver.ts#L124) - -#### Returns - -`void` - -#### Inherited from - -[`QueryObserver`](QueryObserver.md).[`onUnsubscribe`](QueryObserver.md#onunsubscribe) - -*** - ### refetch() ```ts diff --git a/docs/framework/react/reference/classes/Mutation.md b/docs/framework/react/reference/classes/Mutation.md index fa3b9c79522..c1fc2ce5591 100644 --- a/docs/framework/react/reference/classes/Mutation.md +++ b/docs/framework/react/reference/classes/Mutation.md @@ -136,26 +136,6 @@ The `meta` object passed in the mutation's options, if any. ## Methods -### clearGcTimeout() - -```ts -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) - -#### Returns - -`void` - -#### Inherited from - -```ts -Removable.clearGcTimeout -``` - -*** - ### continue() ```ts @@ -262,69 +242,3 @@ const data = await mutation.execute(variables) #### See [Mutation#continue](#continue) - -*** - -### optionalRemove() - -```ts -protected optionalRemove(): void; -``` - -Defined in: [packages/query-core/src/mutation.ts:212](https://github.com/TanStack/query/blob/main/packages/query-core/src/mutation.ts#L212) - -#### Returns - -`void` - -#### Overrides - -```ts -Removable.optionalRemove -``` - -*** - -### scheduleGc() - -```ts -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) - -#### Returns - -`void` - -#### Inherited from - -```ts -Removable.scheduleGc -``` - -*** - -### updateGcTime() - -```ts -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) - -#### Parameters - -##### newGcTime - -`number` | `undefined` - -#### Returns - -`void` - -#### Inherited from - -```ts -Removable.updateGcTime -``` diff --git a/docs/framework/react/reference/classes/MutationCache.md b/docs/framework/react/reference/classes/MutationCache.md index f5643fb5fe1..619cb7c5eb2 100644 --- a/docs/framework/react/reference/classes/MutationCache.md +++ b/docs/framework/react/reference/classes/MutationCache.md @@ -62,22 +62,6 @@ config: MutationCacheConfig = {}; Defined in: [packages/query-core/src/mutationCache.ts:129](https://github.com/TanStack/query/blob/main/packages/query-core/src/mutationCache.ts#L129) -*** - -### listeners - -```ts -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) - -#### Inherited from - -```ts -Subscribable.listeners -``` - ## Methods ### clear() @@ -248,46 +232,6 @@ Subscribable.hasListeners *** -### onSubscribe() - -```ts -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) - -#### Returns - -`void` - -#### Inherited from - -```ts -Subscribable.onSubscribe -``` - -*** - -### onUnsubscribe() - -```ts -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) - -#### Returns - -`void` - -#### Inherited from - -```ts -Subscribable.onUnsubscribe -``` - -*** - ### subscribe() ```ts diff --git a/docs/framework/react/reference/classes/MutationObserver.md b/docs/framework/react/reference/classes/MutationObserver.md index 90bac0ff994..9c9ab3a0b8e 100644 --- a/docs/framework/react/reference/classes/MutationObserver.md +++ b/docs/framework/react/reference/classes/MutationObserver.md @@ -76,22 +76,6 @@ Subscribable< ## Properties -### listeners - -```ts -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) - -#### Inherited from - -```ts -Subscribable.listeners -``` - -*** - ### options ```ts @@ -102,20 +86,6 @@ Defined in: [packages/query-core/src/mutationObserver.ts:46](https://github.com/ ## Methods -### bindMethods() - -```ts -protected bindMethods(): void; -``` - -Defined in: [packages/query-core/src/mutationObserver.ts:75](https://github.com/TanStack/query/blob/main/packages/query-core/src/mutationObserver.ts#L75) - -#### Returns - -`void` - -*** - ### getCurrentResult() ```ts @@ -196,46 +166,6 @@ await observer.mutate( *** -### onSubscribe() - -```ts -protected onSubscribe(): void; -``` - -Defined in: [packages/query-core/src/mutationObserver.ts:127](https://github.com/TanStack/query/blob/main/packages/query-core/src/mutationObserver.ts#L127) - -#### Returns - -`void` - -#### Overrides - -```ts -Subscribable.onSubscribe -``` - -*** - -### onUnsubscribe() - -```ts -protected onUnsubscribe(): void; -``` - -Defined in: [packages/query-core/src/mutationObserver.ts:135](https://github.com/TanStack/query/blob/main/packages/query-core/src/mutationObserver.ts#L135) - -#### Returns - -`void` - -#### Overrides - -```ts -Subscribable.onUnsubscribe -``` - -*** - ### reset() ```ts diff --git a/docs/framework/react/reference/classes/QueriesObserver.md b/docs/framework/react/reference/classes/QueriesObserver.md index 0bfdcccbf00..fc33180c875 100644 --- a/docs/framework/react/reference/classes/QueriesObserver.md +++ b/docs/framework/react/reference/classes/QueriesObserver.md @@ -74,22 +74,6 @@ Defined in: [packages/query-core/src/queriesObserver.ts:70](https://github.com/T Subscribable.constructor ``` -## Properties - -### listeners - -```ts -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) - -#### Inherited from - -```ts -Subscribable.listeners -``` - ## Methods ### destroy() @@ -219,46 +203,6 @@ Subscribable.hasListeners *** -### onSubscribe() - -```ts -protected onSubscribe(): void; -``` - -Defined in: [packages/query-core/src/queriesObserver.ts:86](https://github.com/TanStack/query/blob/main/packages/query-core/src/queriesObserver.ts#L86) - -#### Returns - -`void` - -#### Overrides - -```ts -Subscribable.onSubscribe -``` - -*** - -### onUnsubscribe() - -```ts -protected onUnsubscribe(): void; -``` - -Defined in: [packages/query-core/src/queriesObserver.ts:96](https://github.com/TanStack/query/blob/main/packages/query-core/src/queriesObserver.ts#L96) - -#### Returns - -`void` - -#### Overrides - -```ts -Subscribable.onUnsubscribe -``` - -*** - ### setQueries() ```ts diff --git a/docs/framework/react/reference/classes/Query.md b/docs/framework/react/reference/classes/Query.md index fee2fb07529..c2f8369bbad 100644 --- a/docs/framework/react/reference/classes/Query.md +++ b/docs/framework/react/reference/classes/Query.md @@ -207,26 +207,6 @@ await query.cancel() *** -### clearGcTimeout() - -```ts -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) - -#### Returns - -`void` - -#### Inherited from - -```ts -Removable.clearGcTimeout -``` - -*** - ### destroy() ```ts @@ -478,26 +458,6 @@ Returns `true` if the query has at least one observer configured with *** -### optionalRemove() - -```ts -protected optionalRemove(): void; -``` - -Defined in: [packages/query-core/src/query.ts:305](https://github.com/TanStack/query/blob/main/packages/query-core/src/query.ts#L305) - -#### Returns - -`void` - -#### Overrides - -```ts -Removable.optionalRemove -``` - -*** - ### reset() ```ts @@ -516,26 +476,6 @@ in-flight fetch. *** -### scheduleGc() - -```ts -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) - -#### Returns - -`void` - -#### Inherited from - -```ts -Removable.scheduleGc -``` - -*** - ### setState() ```ts @@ -557,29 +497,3 @@ user manually trigger a loading/error state or edit the cached data. #### Returns `void` - -*** - -### updateGcTime() - -```ts -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) - -#### Parameters - -##### newGcTime - -`number` | `undefined` - -#### Returns - -`void` - -#### Inherited from - -```ts -Removable.updateGcTime -``` diff --git a/docs/framework/react/reference/classes/QueryCache.md b/docs/framework/react/reference/classes/QueryCache.md index 749af9a1bca..aa51d35e879 100644 --- a/docs/framework/react/reference/classes/QueryCache.md +++ b/docs/framework/react/reference/classes/QueryCache.md @@ -65,22 +65,6 @@ config: QueryCacheConfig = {}; Defined in: [packages/query-core/src/queryCache.ts:126](https://github.com/TanStack/query/blob/main/packages/query-core/src/queryCache.ts#L126) -*** - -### listeners - -```ts -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) - -#### Inherited from - -```ts -Subscribable.listeners -``` - ## Methods ### build() @@ -367,46 +351,6 @@ Subscribable.hasListeners *** -### onSubscribe() - -```ts -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) - -#### Returns - -`void` - -#### Inherited from - -```ts -Subscribable.onSubscribe -``` - -*** - -### onUnsubscribe() - -```ts -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) - -#### Returns - -`void` - -#### Inherited from - -```ts -Subscribable.onUnsubscribe -``` - -*** - ### remove() ```ts diff --git a/docs/framework/react/reference/classes/QueryObserver.md b/docs/framework/react/reference/classes/QueryObserver.md index bafb738ee20..d639ddf1771 100644 --- a/docs/framework/react/reference/classes/QueryObserver.md +++ b/docs/framework/react/reference/classes/QueryObserver.md @@ -90,22 +90,6 @@ Subscribable>.constructor ## Properties -### listeners - -```ts -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) - -#### Inherited from - -```ts -Subscribable.listeners -``` - -*** - ### options ```ts @@ -116,44 +100,6 @@ Defined in: [packages/query-core/src/queryObserver.ts:89](https://github.com/Tan ## Methods -### bindMethods() - -```ts -protected bindMethods(): void; -``` - -Defined in: [packages/query-core/src/queryObserver.ts:106](https://github.com/TanStack/query/blob/main/packages/query-core/src/queryObserver.ts#L106) - -#### Returns - -`void` - -*** - -### createResult() - -```ts -protected createResult(query: Query, options: QueryObserverOptions): QueryObserverResult; -``` - -Defined in: [packages/query-core/src/queryObserver.ts:559](https://github.com/TanStack/query/blob/main/packages/query-core/src/queryObserver.ts#L559) - -#### Parameters - -##### query - -[`Query`](Query.md)\<`TQueryFnData`, `TError`, `TQueryData`, `TQueryKey`\> - -##### options - -[`QueryObserverOptions`](../interfaces/QueryObserverOptions.md)\<`TQueryFnData`, `TError`, `TData`, `TQueryData`, `TQueryKey`\> - -#### Returns - -[`QueryObserverResult`](../type-aliases/QueryObserverResult.md)\<`TData`, `TError`\> - -*** - ### destroy() ```ts @@ -172,26 +118,6 @@ query it was observing. *** -### fetch() - -```ts -protected fetch(fetchOptions: ObserverFetchOptions): Promise>; -``` - -Defined in: [packages/query-core/src/queryObserver.ts:448](https://github.com/TanStack/query/blob/main/packages/query-core/src/queryObserver.ts#L448) - -#### Parameters - -##### fetchOptions - -`ObserverFetchOptions` - -#### Returns - -`Promise`\<[`QueryObserverResult`](../type-aliases/QueryObserverResult.md)\<`TData`, `TError`\>\> - -*** - ### fetchOptimistic() ```ts @@ -315,46 +241,6 @@ Subscribable.hasListeners *** -### onSubscribe() - -```ts -protected onSubscribe(): void; -``` - -Defined in: [packages/query-core/src/queryObserver.ts:110](https://github.com/TanStack/query/blob/main/packages/query-core/src/queryObserver.ts#L110) - -#### Returns - -`void` - -#### Overrides - -```ts -Subscribable.onSubscribe -``` - -*** - -### onUnsubscribe() - -```ts -protected onUnsubscribe(): void; -``` - -Defined in: [packages/query-core/src/queryObserver.ts:124](https://github.com/TanStack/query/blob/main/packages/query-core/src/queryObserver.ts#L124) - -#### Returns - -`void` - -#### Overrides - -```ts -Subscribable.onUnsubscribe -``` - -*** - ### refetch() ```ts diff --git a/docs/framework/react/reference/interfaces/FocusManager.md b/docs/framework/react/reference/interfaces/FocusManager.md index a4905c66cb3..ec1732deb38 100644 --- a/docs/framework/react/reference/interfaces/FocusManager.md +++ b/docs/framework/react/reference/interfaces/FocusManager.md @@ -16,12 +16,6 @@ It can be used to change the default event listeners or to manually change the f - `Subscribable`\<`Listener`\> -## Properties - -| Property | Modifier | Type | -| ------ | ------ | ------ | -| `listeners` | `protected` | `Set`\<`Listener`\> | - ## Methods ### hasListeners() @@ -76,46 +70,6 @@ Defined in: [packages/query-core/src/focusManager.ts:118](https://github.com/Tan *** -### onSubscribe() - -```ts -protected onSubscribe(): void; -``` - -Defined in: [packages/query-core/src/focusManager.ts:39](https://github.com/TanStack/query/blob/main/packages/query-core/src/focusManager.ts#L39) - -#### Returns - -`void` - -#### Overrides - -```ts -Subscribable.onSubscribe -``` - -*** - -### onUnsubscribe() - -```ts -protected onUnsubscribe(): void; -``` - -Defined in: [packages/query-core/src/focusManager.ts:45](https://github.com/TanStack/query/blob/main/packages/query-core/src/focusManager.ts#L45) - -#### Returns - -`void` - -#### Overrides - -```ts -Subscribable.onUnsubscribe -``` - -*** - ### setEventListener() ```ts diff --git a/docs/framework/react/reference/interfaces/OnlineManager.md b/docs/framework/react/reference/interfaces/OnlineManager.md index 9bba37298ff..521dca3af8c 100644 --- a/docs/framework/react/reference/interfaces/OnlineManager.md +++ b/docs/framework/react/reference/interfaces/OnlineManager.md @@ -20,12 +20,6 @@ detect changes. - `Subscribable`\<`Listener`\> -## Properties - -| Property | Modifier | Type | -| ------ | ------ | ------ | -| `listeners` | `protected` | `Set`\<`Listener`\> | - ## Methods ### hasListeners() @@ -64,46 +58,6 @@ Defined in: [packages/query-core/src/onlineManager.ts:109](https://github.com/Ta *** -### onSubscribe() - -```ts -protected onSubscribe(): void; -``` - -Defined in: [packages/query-core/src/onlineManager.ts:44](https://github.com/TanStack/query/blob/main/packages/query-core/src/onlineManager.ts#L44) - -#### Returns - -`void` - -#### Overrides - -```ts -Subscribable.onSubscribe -``` - -*** - -### onUnsubscribe() - -```ts -protected onUnsubscribe(): void; -``` - -Defined in: [packages/query-core/src/onlineManager.ts:50](https://github.com/TanStack/query/blob/main/packages/query-core/src/onlineManager.ts#L50) - -#### Returns - -`void` - -#### Overrides - -```ts -Subscribable.onUnsubscribe -``` - -*** - ### setEventListener() ```ts diff --git a/docs/framework/solid/reference/classes/InfiniteQueryObserver.md b/docs/framework/solid/reference/classes/InfiniteQueryObserver.md index 836e3d52947..ac9e761580c 100644 --- a/docs/framework/solid/reference/classes/InfiniteQueryObserver.md +++ b/docs/framework/solid/reference/classes/InfiniteQueryObserver.md @@ -80,22 +80,6 @@ Defined in: [packages/query-core/src/infiniteQueryObserver.ts:83](https://github ## Properties -### fetch - -```ts -protected fetch: ReplaceReturnType<(fetchOptions: ObserverFetchOptions) => Promise>, Promise>>; -``` - -Defined in: [packages/query-core/src/infiniteQueryObserver.ts:72](https://github.com/TanStack/query/blob/main/packages/query-core/src/infiniteQueryObserver.ts#L72) - -#### Overrides - -```ts -QueryObserver.fetch -``` - -*** - ### getCurrentResult ```ts @@ -124,20 +108,6 @@ QueryObserver.getCurrentResult *** -### listeners - -```ts -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) - -#### Inherited from - -[`QueryObserver`](QueryObserver.md).[`listeners`](QueryObserver.md#listeners) - -*** - ### options ```ts @@ -184,52 +154,6 @@ QueryObserver.subscribe ## Methods -### bindMethods() - -```ts -protected bindMethods(): void; -``` - -Defined in: [packages/query-core/src/infiniteQueryObserver.ts:96](https://github.com/TanStack/query/blob/main/packages/query-core/src/infiniteQueryObserver.ts#L96) - -#### Returns - -`void` - -#### Overrides - -[`QueryObserver`](QueryObserver.md).[`bindMethods`](QueryObserver.md#bindmethods) - -*** - -### createResult() - -```ts -protected createResult(query: Query, TQueryKey>, options: InfiniteQueryObserverOptions): InfiniteQueryObserverResult; -``` - -Defined in: [packages/query-core/src/infiniteQueryObserver.ts:201](https://github.com/TanStack/query/blob/main/packages/query-core/src/infiniteQueryObserver.ts#L201) - -#### Parameters - -##### query - -[`Query`](Query.md)\<`TQueryFnData`, `TError`, [`InfiniteData`](../interfaces/InfiniteData.md)\<`TQueryFnData`, `TPageParam`\>, `TQueryKey`\> - -##### options - -`InfiniteQueryObserverOptions`\<`TQueryFnData`, `TError`, `TData`, `TQueryKey`, `TPageParam`\> - -#### Returns - -[`InfiniteQueryObserverResult`](../type-aliases/InfiniteQueryObserverResult.md)\<`TData`, `TError`\> - -#### Overrides - -[`QueryObserver`](QueryObserver.md).[`createResult`](QueryObserver.md#createresult) - -*** - ### destroy() ```ts @@ -439,42 +363,6 @@ Defined in: [packages/query-core/src/subscribable.ts:19](https://github.com/TanS *** -### onSubscribe() - -```ts -protected onSubscribe(): void; -``` - -Defined in: [packages/query-core/src/queryObserver.ts:110](https://github.com/TanStack/query/blob/main/packages/query-core/src/queryObserver.ts#L110) - -#### Returns - -`void` - -#### Inherited from - -[`QueryObserver`](QueryObserver.md).[`onSubscribe`](QueryObserver.md#onsubscribe) - -*** - -### onUnsubscribe() - -```ts -protected onUnsubscribe(): void; -``` - -Defined in: [packages/query-core/src/queryObserver.ts:124](https://github.com/TanStack/query/blob/main/packages/query-core/src/queryObserver.ts#L124) - -#### Returns - -`void` - -#### Inherited from - -[`QueryObserver`](QueryObserver.md).[`onUnsubscribe`](QueryObserver.md#onunsubscribe) - -*** - ### refetch() ```ts diff --git a/docs/framework/solid/reference/classes/Mutation.md b/docs/framework/solid/reference/classes/Mutation.md index fa3b9c79522..c1fc2ce5591 100644 --- a/docs/framework/solid/reference/classes/Mutation.md +++ b/docs/framework/solid/reference/classes/Mutation.md @@ -136,26 +136,6 @@ The `meta` object passed in the mutation's options, if any. ## Methods -### clearGcTimeout() - -```ts -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) - -#### Returns - -`void` - -#### Inherited from - -```ts -Removable.clearGcTimeout -``` - -*** - ### continue() ```ts @@ -262,69 +242,3 @@ const data = await mutation.execute(variables) #### See [Mutation#continue](#continue) - -*** - -### optionalRemove() - -```ts -protected optionalRemove(): void; -``` - -Defined in: [packages/query-core/src/mutation.ts:212](https://github.com/TanStack/query/blob/main/packages/query-core/src/mutation.ts#L212) - -#### Returns - -`void` - -#### Overrides - -```ts -Removable.optionalRemove -``` - -*** - -### scheduleGc() - -```ts -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) - -#### Returns - -`void` - -#### Inherited from - -```ts -Removable.scheduleGc -``` - -*** - -### updateGcTime() - -```ts -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) - -#### Parameters - -##### newGcTime - -`number` | `undefined` - -#### Returns - -`void` - -#### Inherited from - -```ts -Removable.updateGcTime -``` diff --git a/docs/framework/solid/reference/classes/MutationCache.md b/docs/framework/solid/reference/classes/MutationCache.md index 65015530c74..c00fbc4a149 100644 --- a/docs/framework/solid/reference/classes/MutationCache.md +++ b/docs/framework/solid/reference/classes/MutationCache.md @@ -59,22 +59,6 @@ config: MutationCacheConfig = {}; Defined in: [packages/query-core/src/mutationCache.ts:129](https://github.com/TanStack/query/blob/main/packages/query-core/src/mutationCache.ts#L129) -*** - -### listeners - -```ts -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) - -#### Inherited from - -```ts -Subscribable.listeners -``` - ## Methods ### clear() @@ -245,46 +229,6 @@ Subscribable.hasListeners *** -### onSubscribe() - -```ts -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) - -#### Returns - -`void` - -#### Inherited from - -```ts -Subscribable.onSubscribe -``` - -*** - -### onUnsubscribe() - -```ts -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) - -#### Returns - -`void` - -#### Inherited from - -```ts -Subscribable.onUnsubscribe -``` - -*** - ### subscribe() ```ts diff --git a/docs/framework/solid/reference/classes/MutationObserver.md b/docs/framework/solid/reference/classes/MutationObserver.md index b0a5f850b74..2e7d2fdc34d 100644 --- a/docs/framework/solid/reference/classes/MutationObserver.md +++ b/docs/framework/solid/reference/classes/MutationObserver.md @@ -76,22 +76,6 @@ Subscribable< ## Properties -### listeners - -```ts -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) - -#### Inherited from - -```ts -Subscribable.listeners -``` - -*** - ### options ```ts @@ -102,20 +86,6 @@ Defined in: [packages/query-core/src/mutationObserver.ts:46](https://github.com/ ## Methods -### bindMethods() - -```ts -protected bindMethods(): void; -``` - -Defined in: [packages/query-core/src/mutationObserver.ts:75](https://github.com/TanStack/query/blob/main/packages/query-core/src/mutationObserver.ts#L75) - -#### Returns - -`void` - -*** - ### getCurrentResult() ```ts @@ -196,46 +166,6 @@ await observer.mutate( *** -### onSubscribe() - -```ts -protected onSubscribe(): void; -``` - -Defined in: [packages/query-core/src/mutationObserver.ts:127](https://github.com/TanStack/query/blob/main/packages/query-core/src/mutationObserver.ts#L127) - -#### Returns - -`void` - -#### Overrides - -```ts -Subscribable.onSubscribe -``` - -*** - -### onUnsubscribe() - -```ts -protected onUnsubscribe(): void; -``` - -Defined in: [packages/query-core/src/mutationObserver.ts:135](https://github.com/TanStack/query/blob/main/packages/query-core/src/mutationObserver.ts#L135) - -#### Returns - -`void` - -#### Overrides - -```ts -Subscribable.onUnsubscribe -``` - -*** - ### reset() ```ts diff --git a/docs/framework/solid/reference/classes/QueriesObserver.md b/docs/framework/solid/reference/classes/QueriesObserver.md index 0ab09d19e60..6a49765957b 100644 --- a/docs/framework/solid/reference/classes/QueriesObserver.md +++ b/docs/framework/solid/reference/classes/QueriesObserver.md @@ -71,22 +71,6 @@ Defined in: [packages/query-core/src/queriesObserver.ts:70](https://github.com/T Subscribable.constructor ``` -## Properties - -### listeners - -```ts -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) - -#### Inherited from - -```ts -Subscribable.listeners -``` - ## Methods ### destroy() @@ -216,46 +200,6 @@ Subscribable.hasListeners *** -### onSubscribe() - -```ts -protected onSubscribe(): void; -``` - -Defined in: [packages/query-core/src/queriesObserver.ts:86](https://github.com/TanStack/query/blob/main/packages/query-core/src/queriesObserver.ts#L86) - -#### Returns - -`void` - -#### Overrides - -```ts -Subscribable.onSubscribe -``` - -*** - -### onUnsubscribe() - -```ts -protected onUnsubscribe(): void; -``` - -Defined in: [packages/query-core/src/queriesObserver.ts:96](https://github.com/TanStack/query/blob/main/packages/query-core/src/queriesObserver.ts#L96) - -#### Returns - -`void` - -#### Overrides - -```ts -Subscribable.onUnsubscribe -``` - -*** - ### setQueries() ```ts diff --git a/docs/framework/solid/reference/classes/Query.md b/docs/framework/solid/reference/classes/Query.md index a996eb21a15..9dacbe8fe89 100644 --- a/docs/framework/solid/reference/classes/Query.md +++ b/docs/framework/solid/reference/classes/Query.md @@ -207,26 +207,6 @@ await query.cancel() *** -### clearGcTimeout() - -```ts -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) - -#### Returns - -`void` - -#### Inherited from - -```ts -Removable.clearGcTimeout -``` - -*** - ### destroy() ```ts @@ -478,26 +458,6 @@ Returns `true` if the query has at least one observer configured with *** -### optionalRemove() - -```ts -protected optionalRemove(): void; -``` - -Defined in: [packages/query-core/src/query.ts:305](https://github.com/TanStack/query/blob/main/packages/query-core/src/query.ts#L305) - -#### Returns - -`void` - -#### Overrides - -```ts -Removable.optionalRemove -``` - -*** - ### reset() ```ts @@ -516,26 +476,6 @@ in-flight fetch. *** -### scheduleGc() - -```ts -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) - -#### Returns - -`void` - -#### Inherited from - -```ts -Removable.scheduleGc -``` - -*** - ### setState() ```ts @@ -557,29 +497,3 @@ user manually trigger a loading/error state or edit the cached data. #### Returns `void` - -*** - -### updateGcTime() - -```ts -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) - -#### Parameters - -##### newGcTime - -`number` | `undefined` - -#### Returns - -`void` - -#### Inherited from - -```ts -Removable.updateGcTime -``` diff --git a/docs/framework/solid/reference/classes/QueryCache.md b/docs/framework/solid/reference/classes/QueryCache.md index fab04311c1b..9d9f364430b 100644 --- a/docs/framework/solid/reference/classes/QueryCache.md +++ b/docs/framework/solid/reference/classes/QueryCache.md @@ -62,22 +62,6 @@ config: QueryCacheConfig = {}; Defined in: [packages/query-core/src/queryCache.ts:126](https://github.com/TanStack/query/blob/main/packages/query-core/src/queryCache.ts#L126) -*** - -### listeners - -```ts -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) - -#### Inherited from - -```ts -Subscribable.listeners -``` - ## Methods ### build() @@ -364,46 +348,6 @@ Subscribable.hasListeners *** -### onSubscribe() - -```ts -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) - -#### Returns - -`void` - -#### Inherited from - -```ts -Subscribable.onSubscribe -``` - -*** - -### onUnsubscribe() - -```ts -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) - -#### Returns - -`void` - -#### Inherited from - -```ts -Subscribable.onUnsubscribe -``` - -*** - ### remove() ```ts diff --git a/docs/framework/solid/reference/classes/QueryObserver.md b/docs/framework/solid/reference/classes/QueryObserver.md index 87b45f54c5f..c874063f15a 100644 --- a/docs/framework/solid/reference/classes/QueryObserver.md +++ b/docs/framework/solid/reference/classes/QueryObserver.md @@ -87,22 +87,6 @@ Subscribable>.constructor ## Properties -### listeners - -```ts -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) - -#### Inherited from - -```ts -Subscribable.listeners -``` - -*** - ### options ```ts @@ -113,44 +97,6 @@ Defined in: [packages/query-core/src/queryObserver.ts:89](https://github.com/Tan ## Methods -### bindMethods() - -```ts -protected bindMethods(): void; -``` - -Defined in: [packages/query-core/src/queryObserver.ts:106](https://github.com/TanStack/query/blob/main/packages/query-core/src/queryObserver.ts#L106) - -#### Returns - -`void` - -*** - -### createResult() - -```ts -protected createResult(query: Query, options: QueryObserverOptions): QueryObserverResult; -``` - -Defined in: [packages/query-core/src/queryObserver.ts:559](https://github.com/TanStack/query/blob/main/packages/query-core/src/queryObserver.ts#L559) - -#### Parameters - -##### query - -[`Query`](Query.md)\<`TQueryFnData`, `TError`, `TQueryData`, `TQueryKey`\> - -##### options - -`QueryObserverOptions`\<`TQueryFnData`, `TError`, `TData`, `TQueryData`, `TQueryKey`\> - -#### Returns - -[`QueryObserverResult`](../type-aliases/QueryObserverResult.md)\<`TData`, `TError`\> - -*** - ### destroy() ```ts @@ -169,26 +115,6 @@ query it was observing. *** -### fetch() - -```ts -protected fetch(fetchOptions: ObserverFetchOptions): Promise>; -``` - -Defined in: [packages/query-core/src/queryObserver.ts:448](https://github.com/TanStack/query/blob/main/packages/query-core/src/queryObserver.ts#L448) - -#### Parameters - -##### fetchOptions - -`ObserverFetchOptions` - -#### Returns - -`Promise`\<[`QueryObserverResult`](../type-aliases/QueryObserverResult.md)\<`TData`, `TError`\>\> - -*** - ### fetchOptimistic() ```ts @@ -312,46 +238,6 @@ Subscribable.hasListeners *** -### onSubscribe() - -```ts -protected onSubscribe(): void; -``` - -Defined in: [packages/query-core/src/queryObserver.ts:110](https://github.com/TanStack/query/blob/main/packages/query-core/src/queryObserver.ts#L110) - -#### Returns - -`void` - -#### Overrides - -```ts -Subscribable.onSubscribe -``` - -*** - -### onUnsubscribe() - -```ts -protected onUnsubscribe(): void; -``` - -Defined in: [packages/query-core/src/queryObserver.ts:124](https://github.com/TanStack/query/blob/main/packages/query-core/src/queryObserver.ts#L124) - -#### Returns - -`void` - -#### Overrides - -```ts -Subscribable.onUnsubscribe -``` - -*** - ### refetch() ```ts diff --git a/docs/framework/solid/reference/interfaces/FocusManager.md b/docs/framework/solid/reference/interfaces/FocusManager.md index 63e0813388a..6865e1339fa 100644 --- a/docs/framework/solid/reference/interfaces/FocusManager.md +++ b/docs/framework/solid/reference/interfaces/FocusManager.md @@ -13,12 +13,6 @@ It can be used to change the default event listeners or to manually change the f - `Subscribable`\<`Listener`\> -## Properties - -| Property | Modifier | Type | -| ------ | ------ | ------ | -| `listeners` | `protected` | `Set`\<`Listener`\> | - ## Methods ### hasListeners() @@ -73,46 +67,6 @@ Defined in: [packages/query-core/src/focusManager.ts:118](https://github.com/Tan *** -### onSubscribe() - -```ts -protected onSubscribe(): void; -``` - -Defined in: [packages/query-core/src/focusManager.ts:39](https://github.com/TanStack/query/blob/main/packages/query-core/src/focusManager.ts#L39) - -#### Returns - -`void` - -#### Overrides - -```ts -Subscribable.onSubscribe -``` - -*** - -### onUnsubscribe() - -```ts -protected onUnsubscribe(): void; -``` - -Defined in: [packages/query-core/src/focusManager.ts:45](https://github.com/TanStack/query/blob/main/packages/query-core/src/focusManager.ts#L45) - -#### Returns - -`void` - -#### Overrides - -```ts -Subscribable.onUnsubscribe -``` - -*** - ### setEventListener() ```ts diff --git a/docs/framework/solid/reference/interfaces/OnlineManager.md b/docs/framework/solid/reference/interfaces/OnlineManager.md index 6f0f71074db..664e3795546 100644 --- a/docs/framework/solid/reference/interfaces/OnlineManager.md +++ b/docs/framework/solid/reference/interfaces/OnlineManager.md @@ -17,12 +17,6 @@ detect changes. - `Subscribable`\<`Listener`\> -## Properties - -| Property | Modifier | Type | -| ------ | ------ | ------ | -| `listeners` | `protected` | `Set`\<`Listener`\> | - ## Methods ### hasListeners() @@ -61,46 +55,6 @@ Defined in: [packages/query-core/src/onlineManager.ts:109](https://github.com/Ta *** -### onSubscribe() - -```ts -protected onSubscribe(): void; -``` - -Defined in: [packages/query-core/src/onlineManager.ts:44](https://github.com/TanStack/query/blob/main/packages/query-core/src/onlineManager.ts#L44) - -#### Returns - -`void` - -#### Overrides - -```ts -Subscribable.onSubscribe -``` - -*** - -### onUnsubscribe() - -```ts -protected onUnsubscribe(): void; -``` - -Defined in: [packages/query-core/src/onlineManager.ts:50](https://github.com/TanStack/query/blob/main/packages/query-core/src/onlineManager.ts#L50) - -#### Returns - -`void` - -#### Overrides - -```ts -Subscribable.onUnsubscribe -``` - -*** - ### setEventListener() ```ts diff --git a/docs/framework/svelte/reference/classes/InfiniteQueryObserver.md b/docs/framework/svelte/reference/classes/InfiniteQueryObserver.md index 0fc1765d488..933d392b3fd 100644 --- a/docs/framework/svelte/reference/classes/InfiniteQueryObserver.md +++ b/docs/framework/svelte/reference/classes/InfiniteQueryObserver.md @@ -80,22 +80,6 @@ Defined in: [packages/query-core/src/infiniteQueryObserver.ts:83](https://github ## Properties -### fetch - -```ts -protected fetch: ReplaceReturnType<(fetchOptions: ObserverFetchOptions) => Promise>, Promise>>; -``` - -Defined in: [packages/query-core/src/infiniteQueryObserver.ts:72](https://github.com/TanStack/query/blob/main/packages/query-core/src/infiniteQueryObserver.ts#L72) - -#### Overrides - -```ts -QueryObserver.fetch -``` - -*** - ### getCurrentResult ```ts @@ -124,20 +108,6 @@ QueryObserver.getCurrentResult *** -### listeners - -```ts -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) - -#### Inherited from - -[`QueryObserver`](QueryObserver.md).[`listeners`](QueryObserver.md#listeners) - -*** - ### options ```ts @@ -184,52 +154,6 @@ QueryObserver.subscribe ## Methods -### bindMethods() - -```ts -protected bindMethods(): void; -``` - -Defined in: [packages/query-core/src/infiniteQueryObserver.ts:96](https://github.com/TanStack/query/blob/main/packages/query-core/src/infiniteQueryObserver.ts#L96) - -#### Returns - -`void` - -#### Overrides - -[`QueryObserver`](QueryObserver.md).[`bindMethods`](QueryObserver.md#bindmethods) - -*** - -### createResult() - -```ts -protected createResult(query: Query, TQueryKey>, options: InfiniteQueryObserverOptions): InfiniteQueryObserverResult; -``` - -Defined in: [packages/query-core/src/infiniteQueryObserver.ts:201](https://github.com/TanStack/query/blob/main/packages/query-core/src/infiniteQueryObserver.ts#L201) - -#### Parameters - -##### query - -[`Query`](Query.md)\<`TQueryFnData`, `TError`, [`InfiniteData`](../interfaces/InfiniteData.md)\<`TQueryFnData`, `TPageParam`\>, `TQueryKey`\> - -##### options - -[`InfiniteQueryObserverOptions`](../interfaces/InfiniteQueryObserverOptions.md)\<`TQueryFnData`, `TError`, `TData`, `TQueryKey`, `TPageParam`\> - -#### Returns - -[`InfiniteQueryObserverResult`](../type-aliases/InfiniteQueryObserverResult.md)\<`TData`, `TError`\> - -#### Overrides - -[`QueryObserver`](QueryObserver.md).[`createResult`](QueryObserver.md#createresult) - -*** - ### destroy() ```ts @@ -439,42 +363,6 @@ Defined in: [packages/query-core/src/subscribable.ts:19](https://github.com/TanS *** -### onSubscribe() - -```ts -protected onSubscribe(): void; -``` - -Defined in: [packages/query-core/src/queryObserver.ts:110](https://github.com/TanStack/query/blob/main/packages/query-core/src/queryObserver.ts#L110) - -#### Returns - -`void` - -#### Inherited from - -[`QueryObserver`](QueryObserver.md).[`onSubscribe`](QueryObserver.md#onsubscribe) - -*** - -### onUnsubscribe() - -```ts -protected onUnsubscribe(): void; -``` - -Defined in: [packages/query-core/src/queryObserver.ts:124](https://github.com/TanStack/query/blob/main/packages/query-core/src/queryObserver.ts#L124) - -#### Returns - -`void` - -#### Inherited from - -[`QueryObserver`](QueryObserver.md).[`onUnsubscribe`](QueryObserver.md#onunsubscribe) - -*** - ### refetch() ```ts diff --git a/docs/framework/svelte/reference/classes/Mutation.md b/docs/framework/svelte/reference/classes/Mutation.md index fa3b9c79522..c1fc2ce5591 100644 --- a/docs/framework/svelte/reference/classes/Mutation.md +++ b/docs/framework/svelte/reference/classes/Mutation.md @@ -136,26 +136,6 @@ The `meta` object passed in the mutation's options, if any. ## Methods -### clearGcTimeout() - -```ts -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) - -#### Returns - -`void` - -#### Inherited from - -```ts -Removable.clearGcTimeout -``` - -*** - ### continue() ```ts @@ -262,69 +242,3 @@ const data = await mutation.execute(variables) #### See [Mutation#continue](#continue) - -*** - -### optionalRemove() - -```ts -protected optionalRemove(): void; -``` - -Defined in: [packages/query-core/src/mutation.ts:212](https://github.com/TanStack/query/blob/main/packages/query-core/src/mutation.ts#L212) - -#### Returns - -`void` - -#### Overrides - -```ts -Removable.optionalRemove -``` - -*** - -### scheduleGc() - -```ts -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) - -#### Returns - -`void` - -#### Inherited from - -```ts -Removable.scheduleGc -``` - -*** - -### updateGcTime() - -```ts -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) - -#### Parameters - -##### newGcTime - -`number` | `undefined` - -#### Returns - -`void` - -#### Inherited from - -```ts -Removable.updateGcTime -``` diff --git a/docs/framework/svelte/reference/classes/MutationCache.md b/docs/framework/svelte/reference/classes/MutationCache.md index 65015530c74..c00fbc4a149 100644 --- a/docs/framework/svelte/reference/classes/MutationCache.md +++ b/docs/framework/svelte/reference/classes/MutationCache.md @@ -59,22 +59,6 @@ config: MutationCacheConfig = {}; Defined in: [packages/query-core/src/mutationCache.ts:129](https://github.com/TanStack/query/blob/main/packages/query-core/src/mutationCache.ts#L129) -*** - -### listeners - -```ts -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) - -#### Inherited from - -```ts -Subscribable.listeners -``` - ## Methods ### clear() @@ -245,46 +229,6 @@ Subscribable.hasListeners *** -### onSubscribe() - -```ts -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) - -#### Returns - -`void` - -#### Inherited from - -```ts -Subscribable.onSubscribe -``` - -*** - -### onUnsubscribe() - -```ts -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) - -#### Returns - -`void` - -#### Inherited from - -```ts -Subscribable.onUnsubscribe -``` - -*** - ### subscribe() ```ts diff --git a/docs/framework/svelte/reference/classes/MutationObserver.md b/docs/framework/svelte/reference/classes/MutationObserver.md index 90bac0ff994..9c9ab3a0b8e 100644 --- a/docs/framework/svelte/reference/classes/MutationObserver.md +++ b/docs/framework/svelte/reference/classes/MutationObserver.md @@ -76,22 +76,6 @@ Subscribable< ## Properties -### listeners - -```ts -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) - -#### Inherited from - -```ts -Subscribable.listeners -``` - -*** - ### options ```ts @@ -102,20 +86,6 @@ Defined in: [packages/query-core/src/mutationObserver.ts:46](https://github.com/ ## Methods -### bindMethods() - -```ts -protected bindMethods(): void; -``` - -Defined in: [packages/query-core/src/mutationObserver.ts:75](https://github.com/TanStack/query/blob/main/packages/query-core/src/mutationObserver.ts#L75) - -#### Returns - -`void` - -*** - ### getCurrentResult() ```ts @@ -196,46 +166,6 @@ await observer.mutate( *** -### onSubscribe() - -```ts -protected onSubscribe(): void; -``` - -Defined in: [packages/query-core/src/mutationObserver.ts:127](https://github.com/TanStack/query/blob/main/packages/query-core/src/mutationObserver.ts#L127) - -#### Returns - -`void` - -#### Overrides - -```ts -Subscribable.onSubscribe -``` - -*** - -### onUnsubscribe() - -```ts -protected onUnsubscribe(): void; -``` - -Defined in: [packages/query-core/src/mutationObserver.ts:135](https://github.com/TanStack/query/blob/main/packages/query-core/src/mutationObserver.ts#L135) - -#### Returns - -`void` - -#### Overrides - -```ts -Subscribable.onUnsubscribe -``` - -*** - ### reset() ```ts diff --git a/docs/framework/svelte/reference/classes/QueriesObserver.md b/docs/framework/svelte/reference/classes/QueriesObserver.md index 8bf48fdbebe..4d862779a87 100644 --- a/docs/framework/svelte/reference/classes/QueriesObserver.md +++ b/docs/framework/svelte/reference/classes/QueriesObserver.md @@ -71,22 +71,6 @@ Defined in: [packages/query-core/src/queriesObserver.ts:70](https://github.com/T Subscribable.constructor ``` -## Properties - -### listeners - -```ts -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) - -#### Inherited from - -```ts -Subscribable.listeners -``` - ## Methods ### destroy() @@ -216,46 +200,6 @@ Subscribable.hasListeners *** -### onSubscribe() - -```ts -protected onSubscribe(): void; -``` - -Defined in: [packages/query-core/src/queriesObserver.ts:86](https://github.com/TanStack/query/blob/main/packages/query-core/src/queriesObserver.ts#L86) - -#### Returns - -`void` - -#### Overrides - -```ts -Subscribable.onSubscribe -``` - -*** - -### onUnsubscribe() - -```ts -protected onUnsubscribe(): void; -``` - -Defined in: [packages/query-core/src/queriesObserver.ts:96](https://github.com/TanStack/query/blob/main/packages/query-core/src/queriesObserver.ts#L96) - -#### Returns - -`void` - -#### Overrides - -```ts -Subscribable.onUnsubscribe -``` - -*** - ### setQueries() ```ts diff --git a/docs/framework/svelte/reference/classes/Query.md b/docs/framework/svelte/reference/classes/Query.md index fee2fb07529..c2f8369bbad 100644 --- a/docs/framework/svelte/reference/classes/Query.md +++ b/docs/framework/svelte/reference/classes/Query.md @@ -207,26 +207,6 @@ await query.cancel() *** -### clearGcTimeout() - -```ts -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) - -#### Returns - -`void` - -#### Inherited from - -```ts -Removable.clearGcTimeout -``` - -*** - ### destroy() ```ts @@ -478,26 +458,6 @@ Returns `true` if the query has at least one observer configured with *** -### optionalRemove() - -```ts -protected optionalRemove(): void; -``` - -Defined in: [packages/query-core/src/query.ts:305](https://github.com/TanStack/query/blob/main/packages/query-core/src/query.ts#L305) - -#### Returns - -`void` - -#### Overrides - -```ts -Removable.optionalRemove -``` - -*** - ### reset() ```ts @@ -516,26 +476,6 @@ in-flight fetch. *** -### scheduleGc() - -```ts -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) - -#### Returns - -`void` - -#### Inherited from - -```ts -Removable.scheduleGc -``` - -*** - ### setState() ```ts @@ -557,29 +497,3 @@ user manually trigger a loading/error state or edit the cached data. #### Returns `void` - -*** - -### updateGcTime() - -```ts -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) - -#### Parameters - -##### newGcTime - -`number` | `undefined` - -#### Returns - -`void` - -#### Inherited from - -```ts -Removable.updateGcTime -``` diff --git a/docs/framework/svelte/reference/classes/QueryCache.md b/docs/framework/svelte/reference/classes/QueryCache.md index 982a6e72fb9..61b747c1de7 100644 --- a/docs/framework/svelte/reference/classes/QueryCache.md +++ b/docs/framework/svelte/reference/classes/QueryCache.md @@ -62,22 +62,6 @@ config: QueryCacheConfig = {}; Defined in: [packages/query-core/src/queryCache.ts:126](https://github.com/TanStack/query/blob/main/packages/query-core/src/queryCache.ts#L126) -*** - -### listeners - -```ts -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) - -#### Inherited from - -```ts -Subscribable.listeners -``` - ## Methods ### build() @@ -364,46 +348,6 @@ Subscribable.hasListeners *** -### onSubscribe() - -```ts -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) - -#### Returns - -`void` - -#### Inherited from - -```ts -Subscribable.onSubscribe -``` - -*** - -### onUnsubscribe() - -```ts -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) - -#### Returns - -`void` - -#### Inherited from - -```ts -Subscribable.onUnsubscribe -``` - -*** - ### remove() ```ts diff --git a/docs/framework/svelte/reference/classes/QueryObserver.md b/docs/framework/svelte/reference/classes/QueryObserver.md index 8f5dd48169e..180c2df63d6 100644 --- a/docs/framework/svelte/reference/classes/QueryObserver.md +++ b/docs/framework/svelte/reference/classes/QueryObserver.md @@ -87,22 +87,6 @@ Subscribable>.constructor ## Properties -### listeners - -```ts -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) - -#### Inherited from - -```ts -Subscribable.listeners -``` - -*** - ### options ```ts @@ -113,44 +97,6 @@ Defined in: [packages/query-core/src/queryObserver.ts:89](https://github.com/Tan ## Methods -### bindMethods() - -```ts -protected bindMethods(): void; -``` - -Defined in: [packages/query-core/src/queryObserver.ts:106](https://github.com/TanStack/query/blob/main/packages/query-core/src/queryObserver.ts#L106) - -#### Returns - -`void` - -*** - -### createResult() - -```ts -protected createResult(query: Query, options: QueryObserverOptions): QueryObserverResult; -``` - -Defined in: [packages/query-core/src/queryObserver.ts:559](https://github.com/TanStack/query/blob/main/packages/query-core/src/queryObserver.ts#L559) - -#### Parameters - -##### query - -[`Query`](Query.md)\<`TQueryFnData`, `TError`, `TQueryData`, `TQueryKey`\> - -##### options - -[`QueryObserverOptions`](../interfaces/QueryObserverOptions.md)\<`TQueryFnData`, `TError`, `TData`, `TQueryData`, `TQueryKey`\> - -#### Returns - -[`QueryObserverResult`](../type-aliases/QueryObserverResult.md)\<`TData`, `TError`\> - -*** - ### destroy() ```ts @@ -169,26 +115,6 @@ query it was observing. *** -### fetch() - -```ts -protected fetch(fetchOptions: ObserverFetchOptions): Promise>; -``` - -Defined in: [packages/query-core/src/queryObserver.ts:448](https://github.com/TanStack/query/blob/main/packages/query-core/src/queryObserver.ts#L448) - -#### Parameters - -##### fetchOptions - -`ObserverFetchOptions` - -#### Returns - -`Promise`\<[`QueryObserverResult`](../type-aliases/QueryObserverResult.md)\<`TData`, `TError`\>\> - -*** - ### fetchOptimistic() ```ts @@ -312,46 +238,6 @@ Subscribable.hasListeners *** -### onSubscribe() - -```ts -protected onSubscribe(): void; -``` - -Defined in: [packages/query-core/src/queryObserver.ts:110](https://github.com/TanStack/query/blob/main/packages/query-core/src/queryObserver.ts#L110) - -#### Returns - -`void` - -#### Overrides - -```ts -Subscribable.onSubscribe -``` - -*** - -### onUnsubscribe() - -```ts -protected onUnsubscribe(): void; -``` - -Defined in: [packages/query-core/src/queryObserver.ts:124](https://github.com/TanStack/query/blob/main/packages/query-core/src/queryObserver.ts#L124) - -#### Returns - -`void` - -#### Overrides - -```ts -Subscribable.onUnsubscribe -``` - -*** - ### refetch() ```ts diff --git a/docs/framework/svelte/reference/interfaces/FocusManager.md b/docs/framework/svelte/reference/interfaces/FocusManager.md index 63e0813388a..6865e1339fa 100644 --- a/docs/framework/svelte/reference/interfaces/FocusManager.md +++ b/docs/framework/svelte/reference/interfaces/FocusManager.md @@ -13,12 +13,6 @@ It can be used to change the default event listeners or to manually change the f - `Subscribable`\<`Listener`\> -## Properties - -| Property | Modifier | Type | -| ------ | ------ | ------ | -| `listeners` | `protected` | `Set`\<`Listener`\> | - ## Methods ### hasListeners() @@ -73,46 +67,6 @@ Defined in: [packages/query-core/src/focusManager.ts:118](https://github.com/Tan *** -### onSubscribe() - -```ts -protected onSubscribe(): void; -``` - -Defined in: [packages/query-core/src/focusManager.ts:39](https://github.com/TanStack/query/blob/main/packages/query-core/src/focusManager.ts#L39) - -#### Returns - -`void` - -#### Overrides - -```ts -Subscribable.onSubscribe -``` - -*** - -### onUnsubscribe() - -```ts -protected onUnsubscribe(): void; -``` - -Defined in: [packages/query-core/src/focusManager.ts:45](https://github.com/TanStack/query/blob/main/packages/query-core/src/focusManager.ts#L45) - -#### Returns - -`void` - -#### Overrides - -```ts -Subscribable.onUnsubscribe -``` - -*** - ### setEventListener() ```ts diff --git a/docs/framework/svelte/reference/interfaces/OnlineManager.md b/docs/framework/svelte/reference/interfaces/OnlineManager.md index 6f0f71074db..664e3795546 100644 --- a/docs/framework/svelte/reference/interfaces/OnlineManager.md +++ b/docs/framework/svelte/reference/interfaces/OnlineManager.md @@ -17,12 +17,6 @@ detect changes. - `Subscribable`\<`Listener`\> -## Properties - -| Property | Modifier | Type | -| ------ | ------ | ------ | -| `listeners` | `protected` | `Set`\<`Listener`\> | - ## Methods ### hasListeners() @@ -61,46 +55,6 @@ Defined in: [packages/query-core/src/onlineManager.ts:109](https://github.com/Ta *** -### onSubscribe() - -```ts -protected onSubscribe(): void; -``` - -Defined in: [packages/query-core/src/onlineManager.ts:44](https://github.com/TanStack/query/blob/main/packages/query-core/src/onlineManager.ts#L44) - -#### Returns - -`void` - -#### Overrides - -```ts -Subscribable.onSubscribe -``` - -*** - -### onUnsubscribe() - -```ts -protected onUnsubscribe(): void; -``` - -Defined in: [packages/query-core/src/onlineManager.ts:50](https://github.com/TanStack/query/blob/main/packages/query-core/src/onlineManager.ts#L50) - -#### Returns - -`void` - -#### Overrides - -```ts -Subscribable.onUnsubscribe -``` - -*** - ### setEventListener() ```ts diff --git a/docs/framework/vue/reference/classes/InfiniteQueryObserver.md b/docs/framework/vue/reference/classes/InfiniteQueryObserver.md index 7553204ff87..a5e554a1831 100644 --- a/docs/framework/vue/reference/classes/InfiniteQueryObserver.md +++ b/docs/framework/vue/reference/classes/InfiniteQueryObserver.md @@ -80,22 +80,6 @@ Defined in: [packages/query-core/src/infiniteQueryObserver.ts:83](https://github ## Properties -### fetch - -```ts -protected fetch: ReplaceReturnType<(fetchOptions: ObserverFetchOptions) => Promise>, Promise>>; -``` - -Defined in: [packages/query-core/src/infiniteQueryObserver.ts:72](https://github.com/TanStack/query/blob/main/packages/query-core/src/infiniteQueryObserver.ts#L72) - -#### Overrides - -```ts -QueryObserver.fetch -``` - -*** - ### getCurrentResult ```ts @@ -124,20 +108,6 @@ QueryObserver.getCurrentResult *** -### listeners - -```ts -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) - -#### Inherited from - -[`QueryObserver`](QueryObserver.md).[`listeners`](QueryObserver.md#listeners) - -*** - ### options ```ts @@ -184,52 +154,6 @@ QueryObserver.subscribe ## Methods -### bindMethods() - -```ts -protected bindMethods(): void; -``` - -Defined in: [packages/query-core/src/infiniteQueryObserver.ts:96](https://github.com/TanStack/query/blob/main/packages/query-core/src/infiniteQueryObserver.ts#L96) - -#### Returns - -`void` - -#### Overrides - -[`QueryObserver`](QueryObserver.md).[`bindMethods`](QueryObserver.md#bindmethods) - -*** - -### createResult() - -```ts -protected createResult(query: Query, TQueryKey>, options: InfiniteQueryObserverOptions): InfiniteQueryObserverResult; -``` - -Defined in: [packages/query-core/src/infiniteQueryObserver.ts:201](https://github.com/TanStack/query/blob/main/packages/query-core/src/infiniteQueryObserver.ts#L201) - -#### Parameters - -##### query - -[`Query`](Query.md)\<`TQueryFnData`, `TError`, [`InfiniteData`](../interfaces/InfiniteData.md)\<`TQueryFnData`, `TPageParam`\>, `TQueryKey`\> - -##### options - -[`InfiniteQueryObserverOptions`](../interfaces/InfiniteQueryObserverOptions.md)\<`TQueryFnData`, `TError`, `TData`, `TQueryKey`, `TPageParam`\> - -#### Returns - -[`InfiniteQueryObserverResult`](../type-aliases/InfiniteQueryObserverResult.md)\<`TData`, `TError`\> - -#### Overrides - -[`QueryObserver`](QueryObserver.md).[`createResult`](QueryObserver.md#createresult) - -*** - ### destroy() ```ts @@ -439,42 +363,6 @@ Defined in: [packages/query-core/src/subscribable.ts:19](https://github.com/TanS *** -### onSubscribe() - -```ts -protected onSubscribe(): void; -``` - -Defined in: [packages/query-core/src/queryObserver.ts:110](https://github.com/TanStack/query/blob/main/packages/query-core/src/queryObserver.ts#L110) - -#### Returns - -`void` - -#### Inherited from - -[`QueryObserver`](QueryObserver.md).[`onSubscribe`](QueryObserver.md#onsubscribe) - -*** - -### onUnsubscribe() - -```ts -protected onUnsubscribe(): void; -``` - -Defined in: [packages/query-core/src/queryObserver.ts:124](https://github.com/TanStack/query/blob/main/packages/query-core/src/queryObserver.ts#L124) - -#### Returns - -`void` - -#### Inherited from - -[`QueryObserver`](QueryObserver.md).[`onUnsubscribe`](QueryObserver.md#onunsubscribe) - -*** - ### refetch() ```ts diff --git a/docs/framework/vue/reference/classes/Mutation.md b/docs/framework/vue/reference/classes/Mutation.md index fa3b9c79522..c1fc2ce5591 100644 --- a/docs/framework/vue/reference/classes/Mutation.md +++ b/docs/framework/vue/reference/classes/Mutation.md @@ -136,26 +136,6 @@ The `meta` object passed in the mutation's options, if any. ## Methods -### clearGcTimeout() - -```ts -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) - -#### Returns - -`void` - -#### Inherited from - -```ts -Removable.clearGcTimeout -``` - -*** - ### continue() ```ts @@ -262,69 +242,3 @@ const data = await mutation.execute(variables) #### See [Mutation#continue](#continue) - -*** - -### optionalRemove() - -```ts -protected optionalRemove(): void; -``` - -Defined in: [packages/query-core/src/mutation.ts:212](https://github.com/TanStack/query/blob/main/packages/query-core/src/mutation.ts#L212) - -#### Returns - -`void` - -#### Overrides - -```ts -Removable.optionalRemove -``` - -*** - -### scheduleGc() - -```ts -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) - -#### Returns - -`void` - -#### Inherited from - -```ts -Removable.scheduleGc -``` - -*** - -### updateGcTime() - -```ts -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) - -#### Parameters - -##### newGcTime - -`number` | `undefined` - -#### Returns - -`void` - -#### Inherited from - -```ts -Removable.updateGcTime -``` diff --git a/docs/framework/vue/reference/classes/MutationCache.md b/docs/framework/vue/reference/classes/MutationCache.md index 4b17e1412af..28a81a99534 100644 --- a/docs/framework/vue/reference/classes/MutationCache.md +++ b/docs/framework/vue/reference/classes/MutationCache.md @@ -55,22 +55,6 @@ Defined in: [packages/query-core/src/mutationCache.ts:129](https://github.com/Ta MC.config ``` -*** - -### listeners - -```ts -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) - -#### Inherited from - -```ts -MC.listeners -``` - ## Methods ### clear() @@ -265,46 +249,6 @@ MC.hasListeners *** -### onSubscribe() - -```ts -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) - -#### Returns - -`void` - -#### Inherited from - -```ts -MC.onSubscribe -``` - -*** - -### onUnsubscribe() - -```ts -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) - -#### Returns - -`void` - -#### Inherited from - -```ts -MC.onUnsubscribe -``` - -*** - ### subscribe() ```ts diff --git a/docs/framework/vue/reference/classes/MutationObserver.md b/docs/framework/vue/reference/classes/MutationObserver.md index b0a5f850b74..2e7d2fdc34d 100644 --- a/docs/framework/vue/reference/classes/MutationObserver.md +++ b/docs/framework/vue/reference/classes/MutationObserver.md @@ -76,22 +76,6 @@ Subscribable< ## Properties -### listeners - -```ts -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) - -#### Inherited from - -```ts -Subscribable.listeners -``` - -*** - ### options ```ts @@ -102,20 +86,6 @@ Defined in: [packages/query-core/src/mutationObserver.ts:46](https://github.com/ ## Methods -### bindMethods() - -```ts -protected bindMethods(): void; -``` - -Defined in: [packages/query-core/src/mutationObserver.ts:75](https://github.com/TanStack/query/blob/main/packages/query-core/src/mutationObserver.ts#L75) - -#### Returns - -`void` - -*** - ### getCurrentResult() ```ts @@ -196,46 +166,6 @@ await observer.mutate( *** -### onSubscribe() - -```ts -protected onSubscribe(): void; -``` - -Defined in: [packages/query-core/src/mutationObserver.ts:127](https://github.com/TanStack/query/blob/main/packages/query-core/src/mutationObserver.ts#L127) - -#### Returns - -`void` - -#### Overrides - -```ts -Subscribable.onSubscribe -``` - -*** - -### onUnsubscribe() - -```ts -protected onUnsubscribe(): void; -``` - -Defined in: [packages/query-core/src/mutationObserver.ts:135](https://github.com/TanStack/query/blob/main/packages/query-core/src/mutationObserver.ts#L135) - -#### Returns - -`void` - -#### Overrides - -```ts -Subscribable.onUnsubscribe -``` - -*** - ### reset() ```ts diff --git a/docs/framework/vue/reference/classes/QueriesObserver.md b/docs/framework/vue/reference/classes/QueriesObserver.md index a8fdea14666..cf168802b15 100644 --- a/docs/framework/vue/reference/classes/QueriesObserver.md +++ b/docs/framework/vue/reference/classes/QueriesObserver.md @@ -71,22 +71,6 @@ Defined in: [packages/query-core/src/queriesObserver.ts:70](https://github.com/T Subscribable.constructor ``` -## Properties - -### listeners - -```ts -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) - -#### Inherited from - -```ts -Subscribable.listeners -``` - ## Methods ### destroy() @@ -216,46 +200,6 @@ Subscribable.hasListeners *** -### onSubscribe() - -```ts -protected onSubscribe(): void; -``` - -Defined in: [packages/query-core/src/queriesObserver.ts:86](https://github.com/TanStack/query/blob/main/packages/query-core/src/queriesObserver.ts#L86) - -#### Returns - -`void` - -#### Overrides - -```ts -Subscribable.onSubscribe -``` - -*** - -### onUnsubscribe() - -```ts -protected onUnsubscribe(): void; -``` - -Defined in: [packages/query-core/src/queriesObserver.ts:96](https://github.com/TanStack/query/blob/main/packages/query-core/src/queriesObserver.ts#L96) - -#### Returns - -`void` - -#### Overrides - -```ts -Subscribable.onUnsubscribe -``` - -*** - ### setQueries() ```ts diff --git a/docs/framework/vue/reference/classes/Query.md b/docs/framework/vue/reference/classes/Query.md index a996eb21a15..9dacbe8fe89 100644 --- a/docs/framework/vue/reference/classes/Query.md +++ b/docs/framework/vue/reference/classes/Query.md @@ -207,26 +207,6 @@ await query.cancel() *** -### clearGcTimeout() - -```ts -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) - -#### Returns - -`void` - -#### Inherited from - -```ts -Removable.clearGcTimeout -``` - -*** - ### destroy() ```ts @@ -478,26 +458,6 @@ Returns `true` if the query has at least one observer configured with *** -### optionalRemove() - -```ts -protected optionalRemove(): void; -``` - -Defined in: [packages/query-core/src/query.ts:305](https://github.com/TanStack/query/blob/main/packages/query-core/src/query.ts#L305) - -#### Returns - -`void` - -#### Overrides - -```ts -Removable.optionalRemove -``` - -*** - ### reset() ```ts @@ -516,26 +476,6 @@ in-flight fetch. *** -### scheduleGc() - -```ts -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) - -#### Returns - -`void` - -#### Inherited from - -```ts -Removable.scheduleGc -``` - -*** - ### setState() ```ts @@ -557,29 +497,3 @@ user manually trigger a loading/error state or edit the cached data. #### Returns `void` - -*** - -### updateGcTime() - -```ts -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) - -#### Parameters - -##### newGcTime - -`number` | `undefined` - -#### Returns - -`void` - -#### Inherited from - -```ts -Removable.updateGcTime -``` diff --git a/docs/framework/vue/reference/classes/QueryCache.md b/docs/framework/vue/reference/classes/QueryCache.md index ad4911294b8..ad5c7019809 100644 --- a/docs/framework/vue/reference/classes/QueryCache.md +++ b/docs/framework/vue/reference/classes/QueryCache.md @@ -55,22 +55,6 @@ Defined in: [packages/query-core/src/queryCache.ts:126](https://github.com/TanSt QC.config ``` -*** - -### listeners - -```ts -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) - -#### Inherited from - -```ts -QC.listeners -``` - ## Methods ### build() @@ -393,46 +377,6 @@ QC.hasListeners *** -### onSubscribe() - -```ts -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) - -#### Returns - -`void` - -#### Inherited from - -```ts -QC.onSubscribe -``` - -*** - -### onUnsubscribe() - -```ts -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) - -#### Returns - -`void` - -#### Inherited from - -```ts -QC.onUnsubscribe -``` - -*** - ### remove() ```ts diff --git a/docs/framework/vue/reference/classes/QueryObserver.md b/docs/framework/vue/reference/classes/QueryObserver.md index 891331d2cb5..feabe3b7e17 100644 --- a/docs/framework/vue/reference/classes/QueryObserver.md +++ b/docs/framework/vue/reference/classes/QueryObserver.md @@ -87,22 +87,6 @@ Subscribable>.constructor ## Properties -### listeners - -```ts -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) - -#### Inherited from - -```ts -Subscribable.listeners -``` - -*** - ### options ```ts @@ -113,44 +97,6 @@ Defined in: [packages/query-core/src/queryObserver.ts:89](https://github.com/Tan ## Methods -### bindMethods() - -```ts -protected bindMethods(): void; -``` - -Defined in: [packages/query-core/src/queryObserver.ts:106](https://github.com/TanStack/query/blob/main/packages/query-core/src/queryObserver.ts#L106) - -#### Returns - -`void` - -*** - -### createResult() - -```ts -protected createResult(query: Query, options: QueryObserverOptions): QueryObserverResult; -``` - -Defined in: [packages/query-core/src/queryObserver.ts:559](https://github.com/TanStack/query/blob/main/packages/query-core/src/queryObserver.ts#L559) - -#### Parameters - -##### query - -[`Query`](Query.md)\<`TQueryFnData`, `TError`, `TQueryData`, `TQueryKey`\> - -##### options - -[`QueryObserverOptions`](../interfaces/QueryObserverOptions.md)\<`TQueryFnData`, `TError`, `TData`, `TQueryData`, `TQueryKey`\> - -#### Returns - -[`QueryObserverResult`](../type-aliases/QueryObserverResult.md)\<`TData`, `TError`\> - -*** - ### destroy() ```ts @@ -169,26 +115,6 @@ query it was observing. *** -### fetch() - -```ts -protected fetch(fetchOptions: ObserverFetchOptions): Promise>; -``` - -Defined in: [packages/query-core/src/queryObserver.ts:448](https://github.com/TanStack/query/blob/main/packages/query-core/src/queryObserver.ts#L448) - -#### Parameters - -##### fetchOptions - -`ObserverFetchOptions` - -#### Returns - -`Promise`\<[`QueryObserverResult`](../type-aliases/QueryObserverResult.md)\<`TData`, `TError`\>\> - -*** - ### fetchOptimistic() ```ts @@ -312,46 +238,6 @@ Subscribable.hasListeners *** -### onSubscribe() - -```ts -protected onSubscribe(): void; -``` - -Defined in: [packages/query-core/src/queryObserver.ts:110](https://github.com/TanStack/query/blob/main/packages/query-core/src/queryObserver.ts#L110) - -#### Returns - -`void` - -#### Overrides - -```ts -Subscribable.onSubscribe -``` - -*** - -### onUnsubscribe() - -```ts -protected onUnsubscribe(): void; -``` - -Defined in: [packages/query-core/src/queryObserver.ts:124](https://github.com/TanStack/query/blob/main/packages/query-core/src/queryObserver.ts#L124) - -#### Returns - -`void` - -#### Overrides - -```ts -Subscribable.onUnsubscribe -``` - -*** - ### refetch() ```ts diff --git a/docs/framework/vue/reference/interfaces/FocusManager.md b/docs/framework/vue/reference/interfaces/FocusManager.md index 63e0813388a..6865e1339fa 100644 --- a/docs/framework/vue/reference/interfaces/FocusManager.md +++ b/docs/framework/vue/reference/interfaces/FocusManager.md @@ -13,12 +13,6 @@ It can be used to change the default event listeners or to manually change the f - `Subscribable`\<`Listener`\> -## Properties - -| Property | Modifier | Type | -| ------ | ------ | ------ | -| `listeners` | `protected` | `Set`\<`Listener`\> | - ## Methods ### hasListeners() @@ -73,46 +67,6 @@ Defined in: [packages/query-core/src/focusManager.ts:118](https://github.com/Tan *** -### onSubscribe() - -```ts -protected onSubscribe(): void; -``` - -Defined in: [packages/query-core/src/focusManager.ts:39](https://github.com/TanStack/query/blob/main/packages/query-core/src/focusManager.ts#L39) - -#### Returns - -`void` - -#### Overrides - -```ts -Subscribable.onSubscribe -``` - -*** - -### onUnsubscribe() - -```ts -protected onUnsubscribe(): void; -``` - -Defined in: [packages/query-core/src/focusManager.ts:45](https://github.com/TanStack/query/blob/main/packages/query-core/src/focusManager.ts#L45) - -#### Returns - -`void` - -#### Overrides - -```ts -Subscribable.onUnsubscribe -``` - -*** - ### setEventListener() ```ts diff --git a/docs/framework/vue/reference/interfaces/OnlineManager.md b/docs/framework/vue/reference/interfaces/OnlineManager.md index 6f0f71074db..664e3795546 100644 --- a/docs/framework/vue/reference/interfaces/OnlineManager.md +++ b/docs/framework/vue/reference/interfaces/OnlineManager.md @@ -17,12 +17,6 @@ detect changes. - `Subscribable`\<`Listener`\> -## Properties - -| Property | Modifier | Type | -| ------ | ------ | ------ | -| `listeners` | `protected` | `Set`\<`Listener`\> | - ## Methods ### hasListeners() @@ -61,46 +55,6 @@ Defined in: [packages/query-core/src/onlineManager.ts:109](https://github.com/Ta *** -### onSubscribe() - -```ts -protected onSubscribe(): void; -``` - -Defined in: [packages/query-core/src/onlineManager.ts:44](https://github.com/TanStack/query/blob/main/packages/query-core/src/onlineManager.ts#L44) - -#### Returns - -`void` - -#### Overrides - -```ts -Subscribable.onSubscribe -``` - -*** - -### onUnsubscribe() - -```ts -protected onUnsubscribe(): void; -``` - -Defined in: [packages/query-core/src/onlineManager.ts:50](https://github.com/TanStack/query/blob/main/packages/query-core/src/onlineManager.ts#L50) - -#### Returns - -`void` - -#### Overrides - -```ts -Subscribable.onUnsubscribe -``` - -*** - ### setEventListener() ```ts diff --git a/scripts/generate-docs.ts b/scripts/generate-docs.ts index c467308652e..49d5661f50d 100644 --- a/scripts/generate-docs.ts +++ b/scripts/generate-docs.ts @@ -169,6 +169,7 @@ async function generatePackageReferenceDocs(pkg: PackageReferenceDocsConfig) { // both omit the parameter types otherwise. expandParameters: true, excludePrivate: true, + excludeProtected: true, excludeInternal: true, excludeExternals: pkg.excludeExternals, sourceLinkTemplate: