diff --git a/docs/framework/angular/reference/classes/InfiniteQueryObserver.md b/docs/framework/angular/reference/classes/InfiniteQueryObserver.md index 5453760e839..7d48487f0d2 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:7](https://github.com/TanStack/query/blob/main/packages/query-core/src/subscribable.ts#L7) - -#### Inherited from - -[`QueryObserver`](QueryObserver.md).[`listeners`](QueryObserver.md#listeners) - -*** - ### options ```ts @@ -200,52 +170,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 @@ -457,42 +381,6 @@ Returns `true` while at least one listener is registered, `false` once they have *** -### 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 49975b76a75..f5840cdfd2f 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:41](https://github.com/TanStack/query/blob/main/packages/query-core/src/removable.ts#L41) - -#### Returns - -`void` - -#### Inherited from - -```ts -Removable.clearGcTimeout -``` - -*** - ### continue() ```ts @@ -266,69 +246,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:23](https://github.com/TanStack/query/blob/main/packages/query-core/src/removable.ts#L23) - -#### Returns - -`void` - -#### Inherited from - -```ts -Removable.scheduleGc -``` - -*** - -### updateGcTime() - -```ts -protected updateGcTime(newGcTime: number | undefined): void; -``` - -Defined in: [packages/query-core/src/removable.ts:33](https://github.com/TanStack/query/blob/main/packages/query-core/src/removable.ts#L33) - -#### 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 b64b17cf0e9..b9d3b847527 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:7](https://github.com/TanStack/query/blob/main/packages/query-core/src/subscribable.ts#L7) - -#### Inherited from - -```ts -Subscribable.listeners -``` - ## Methods ### clear() @@ -247,46 +231,6 @@ Subscribable.hasListeners *** -### onSubscribe() - -```ts -protected onSubscribe(): void; -``` - -Defined in: [packages/query-core/src/subscribable.ts:45](https://github.com/TanStack/query/blob/main/packages/query-core/src/subscribable.ts#L45) - -#### Returns - -`void` - -#### Inherited from - -```ts -Subscribable.onSubscribe -``` - -*** - -### onUnsubscribe() - -```ts -protected onUnsubscribe(): void; -``` - -Defined in: [packages/query-core/src/subscribable.ts:49](https://github.com/TanStack/query/blob/main/packages/query-core/src/subscribable.ts#L49) - -#### 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 e8ba6146fb3..d8170570502 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:7](https://github.com/TanStack/query/blob/main/packages/query-core/src/subscribable.ts#L7) - -#### 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 @@ -198,46 +168,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 ebcbcd9cc97..ae3ccad54da 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:7](https://github.com/TanStack/query/blob/main/packages/query-core/src/subscribable.ts#L7) - -#### Inherited from - -```ts -Subscribable.listeners -``` - ## Methods ### destroy() @@ -218,46 +202,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 646028952e1..0d5b61737ba 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:41](https://github.com/TanStack/query/blob/main/packages/query-core/src/removable.ts#L41) - -#### 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:23](https://github.com/TanStack/query/blob/main/packages/query-core/src/removable.ts#L23) - -#### 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:33](https://github.com/TanStack/query/blob/main/packages/query-core/src/removable.ts#L33) - -#### 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 18520030db7..cea3b27f19a 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:7](https://github.com/TanStack/query/blob/main/packages/query-core/src/subscribable.ts#L7) - -#### Inherited from - -```ts -Subscribable.listeners -``` - ## Methods ### build() @@ -366,46 +350,6 @@ Subscribable.hasListeners *** -### onSubscribe() - -```ts -protected onSubscribe(): void; -``` - -Defined in: [packages/query-core/src/subscribable.ts:45](https://github.com/TanStack/query/blob/main/packages/query-core/src/subscribable.ts#L45) - -#### Returns - -`void` - -#### Inherited from - -```ts -Subscribable.onSubscribe -``` - -*** - -### onUnsubscribe() - -```ts -protected onUnsubscribe(): void; -``` - -Defined in: [packages/query-core/src/subscribable.ts:49](https://github.com/TanStack/query/blob/main/packages/query-core/src/subscribable.ts#L49) - -#### 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 ba20c873925..4c98810f87b 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:7](https://github.com/TanStack/query/blob/main/packages/query-core/src/subscribable.ts#L7) - -#### 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 @@ -314,46 +240,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 c0e6c1dcf22..71c585966d2 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() @@ -75,46 +69,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 e9f911fce4e..1ed3eebcf25 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() @@ -63,46 +57,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 5d1100d8f32..1cfe9c8e6cc 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:7](https://github.com/TanStack/query/blob/main/packages/query-core/src/subscribable.ts#L7) - -#### Inherited from - -[`QueryObserver`](QueryObserver.md).[`listeners`](QueryObserver.md#listeners) - -*** - ### options ```ts @@ -200,52 +170,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 @@ -457,42 +381,6 @@ Returns `true` while at least one listener is registered, `false` once they have *** -### 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 49975b76a75..f5840cdfd2f 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:41](https://github.com/TanStack/query/blob/main/packages/query-core/src/removable.ts#L41) - -#### Returns - -`void` - -#### Inherited from - -```ts -Removable.clearGcTimeout -``` - -*** - ### continue() ```ts @@ -266,69 +246,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:23](https://github.com/TanStack/query/blob/main/packages/query-core/src/removable.ts#L23) - -#### Returns - -`void` - -#### Inherited from - -```ts -Removable.scheduleGc -``` - -*** - -### updateGcTime() - -```ts -protected updateGcTime(newGcTime: number | undefined): void; -``` - -Defined in: [packages/query-core/src/removable.ts:33](https://github.com/TanStack/query/blob/main/packages/query-core/src/removable.ts#L33) - -#### 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 044c175e09c..22105e4908d 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:7](https://github.com/TanStack/query/blob/main/packages/query-core/src/subscribable.ts#L7) - -#### Inherited from - -```ts -Subscribable.listeners -``` - ## Methods ### clear() @@ -247,46 +231,6 @@ Subscribable.hasListeners *** -### onSubscribe() - -```ts -protected onSubscribe(): void; -``` - -Defined in: [packages/query-core/src/subscribable.ts:45](https://github.com/TanStack/query/blob/main/packages/query-core/src/subscribable.ts#L45) - -#### Returns - -`void` - -#### Inherited from - -```ts -Subscribable.onSubscribe -``` - -*** - -### onUnsubscribe() - -```ts -protected onUnsubscribe(): void; -``` - -Defined in: [packages/query-core/src/subscribable.ts:49](https://github.com/TanStack/query/blob/main/packages/query-core/src/subscribable.ts#L49) - -#### 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 e8ba6146fb3..d8170570502 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:7](https://github.com/TanStack/query/blob/main/packages/query-core/src/subscribable.ts#L7) - -#### 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 @@ -198,46 +168,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 534795417f2..1fb8b49268f 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:7](https://github.com/TanStack/query/blob/main/packages/query-core/src/subscribable.ts#L7) - -#### Inherited from - -```ts -Subscribable.listeners -``` - ## Methods ### destroy() @@ -218,46 +202,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 646028952e1..0d5b61737ba 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:41](https://github.com/TanStack/query/blob/main/packages/query-core/src/removable.ts#L41) - -#### 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:23](https://github.com/TanStack/query/blob/main/packages/query-core/src/removable.ts#L23) - -#### 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:33](https://github.com/TanStack/query/blob/main/packages/query-core/src/removable.ts#L33) - -#### 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 7e3862d763a..5524f681e46 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:7](https://github.com/TanStack/query/blob/main/packages/query-core/src/subscribable.ts#L7) - -#### Inherited from - -```ts -Subscribable.listeners -``` - ## Methods ### build() @@ -366,46 +350,6 @@ Subscribable.hasListeners *** -### onSubscribe() - -```ts -protected onSubscribe(): void; -``` - -Defined in: [packages/query-core/src/subscribable.ts:45](https://github.com/TanStack/query/blob/main/packages/query-core/src/subscribable.ts#L45) - -#### Returns - -`void` - -#### Inherited from - -```ts -Subscribable.onSubscribe -``` - -*** - -### onUnsubscribe() - -```ts -protected onUnsubscribe(): void; -``` - -Defined in: [packages/query-core/src/subscribable.ts:49](https://github.com/TanStack/query/blob/main/packages/query-core/src/subscribable.ts#L49) - -#### 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 efa1e07075c..0ff5579ecf5 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:7](https://github.com/TanStack/query/blob/main/packages/query-core/src/subscribable.ts#L7) - -#### 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 @@ -314,46 +240,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 c0e6c1dcf22..71c585966d2 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() @@ -75,46 +69,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 e9f911fce4e..1ed3eebcf25 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() @@ -63,46 +57,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 5453760e839..7d48487f0d2 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:7](https://github.com/TanStack/query/blob/main/packages/query-core/src/subscribable.ts#L7) - -#### Inherited from - -[`QueryObserver`](QueryObserver.md).[`listeners`](QueryObserver.md#listeners) - -*** - ### options ```ts @@ -200,52 +170,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 @@ -457,42 +381,6 @@ Returns `true` while at least one listener is registered, `false` once they have *** -### 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 49975b76a75..f5840cdfd2f 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:41](https://github.com/TanStack/query/blob/main/packages/query-core/src/removable.ts#L41) - -#### Returns - -`void` - -#### Inherited from - -```ts -Removable.clearGcTimeout -``` - -*** - ### continue() ```ts @@ -266,69 +246,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:23](https://github.com/TanStack/query/blob/main/packages/query-core/src/removable.ts#L23) - -#### Returns - -`void` - -#### Inherited from - -```ts -Removable.scheduleGc -``` - -*** - -### updateGcTime() - -```ts -protected updateGcTime(newGcTime: number | undefined): void; -``` - -Defined in: [packages/query-core/src/removable.ts:33](https://github.com/TanStack/query/blob/main/packages/query-core/src/removable.ts#L33) - -#### 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 b64b17cf0e9..b9d3b847527 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:7](https://github.com/TanStack/query/blob/main/packages/query-core/src/subscribable.ts#L7) - -#### Inherited from - -```ts -Subscribable.listeners -``` - ## Methods ### clear() @@ -247,46 +231,6 @@ Subscribable.hasListeners *** -### onSubscribe() - -```ts -protected onSubscribe(): void; -``` - -Defined in: [packages/query-core/src/subscribable.ts:45](https://github.com/TanStack/query/blob/main/packages/query-core/src/subscribable.ts#L45) - -#### Returns - -`void` - -#### Inherited from - -```ts -Subscribable.onSubscribe -``` - -*** - -### onUnsubscribe() - -```ts -protected onUnsubscribe(): void; -``` - -Defined in: [packages/query-core/src/subscribable.ts:49](https://github.com/TanStack/query/blob/main/packages/query-core/src/subscribable.ts#L49) - -#### 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 e8ba6146fb3..d8170570502 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:7](https://github.com/TanStack/query/blob/main/packages/query-core/src/subscribable.ts#L7) - -#### 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 @@ -198,46 +168,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 ebcbcd9cc97..ae3ccad54da 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:7](https://github.com/TanStack/query/blob/main/packages/query-core/src/subscribable.ts#L7) - -#### Inherited from - -```ts -Subscribable.listeners -``` - ## Methods ### destroy() @@ -218,46 +202,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 646028952e1..0d5b61737ba 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:41](https://github.com/TanStack/query/blob/main/packages/query-core/src/removable.ts#L41) - -#### 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:23](https://github.com/TanStack/query/blob/main/packages/query-core/src/removable.ts#L23) - -#### 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:33](https://github.com/TanStack/query/blob/main/packages/query-core/src/removable.ts#L33) - -#### 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 18520030db7..cea3b27f19a 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:7](https://github.com/TanStack/query/blob/main/packages/query-core/src/subscribable.ts#L7) - -#### Inherited from - -```ts -Subscribable.listeners -``` - ## Methods ### build() @@ -366,46 +350,6 @@ Subscribable.hasListeners *** -### onSubscribe() - -```ts -protected onSubscribe(): void; -``` - -Defined in: [packages/query-core/src/subscribable.ts:45](https://github.com/TanStack/query/blob/main/packages/query-core/src/subscribable.ts#L45) - -#### Returns - -`void` - -#### Inherited from - -```ts -Subscribable.onSubscribe -``` - -*** - -### onUnsubscribe() - -```ts -protected onUnsubscribe(): void; -``` - -Defined in: [packages/query-core/src/subscribable.ts:49](https://github.com/TanStack/query/blob/main/packages/query-core/src/subscribable.ts#L49) - -#### 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 ba20c873925..4c98810f87b 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:7](https://github.com/TanStack/query/blob/main/packages/query-core/src/subscribable.ts#L7) - -#### 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 @@ -314,46 +240,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 c0e6c1dcf22..71c585966d2 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() @@ -75,46 +69,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 e9f911fce4e..1ed3eebcf25 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() @@ -63,46 +57,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 c9360dc77f1..542445e3573 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:7](https://github.com/TanStack/query/blob/main/packages/query-core/src/subscribable.ts#L7) - -#### Inherited from - -[`QueryObserver`](QueryObserver.md).[`listeners`](QueryObserver.md#listeners) - -*** - ### options ```ts @@ -203,52 +173,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 @@ -460,42 +384,6 @@ Returns `true` while at least one listener is registered, `false` once they have *** -### 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 49975b76a75..f5840cdfd2f 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:41](https://github.com/TanStack/query/blob/main/packages/query-core/src/removable.ts#L41) - -#### Returns - -`void` - -#### Inherited from - -```ts -Removable.clearGcTimeout -``` - -*** - ### continue() ```ts @@ -266,69 +246,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:23](https://github.com/TanStack/query/blob/main/packages/query-core/src/removable.ts#L23) - -#### Returns - -`void` - -#### Inherited from - -```ts -Removable.scheduleGc -``` - -*** - -### updateGcTime() - -```ts -protected updateGcTime(newGcTime: number | undefined): void; -``` - -Defined in: [packages/query-core/src/removable.ts:33](https://github.com/TanStack/query/blob/main/packages/query-core/src/removable.ts#L33) - -#### 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 dd440d15c63..09f705bb2e3 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:7](https://github.com/TanStack/query/blob/main/packages/query-core/src/subscribable.ts#L7) - -#### Inherited from - -```ts -Subscribable.listeners -``` - ## Methods ### clear() @@ -250,46 +234,6 @@ Subscribable.hasListeners *** -### onSubscribe() - -```ts -protected onSubscribe(): void; -``` - -Defined in: [packages/query-core/src/subscribable.ts:45](https://github.com/TanStack/query/blob/main/packages/query-core/src/subscribable.ts#L45) - -#### Returns - -`void` - -#### Inherited from - -```ts -Subscribable.onSubscribe -``` - -*** - -### onUnsubscribe() - -```ts -protected onUnsubscribe(): void; -``` - -Defined in: [packages/query-core/src/subscribable.ts:49](https://github.com/TanStack/query/blob/main/packages/query-core/src/subscribable.ts#L49) - -#### 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 e8ba6146fb3..d8170570502 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:7](https://github.com/TanStack/query/blob/main/packages/query-core/src/subscribable.ts#L7) - -#### 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 @@ -198,46 +168,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 6ffa32853ac..b0974b01db1 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:7](https://github.com/TanStack/query/blob/main/packages/query-core/src/subscribable.ts#L7) - -#### Inherited from - -```ts -Subscribable.listeners -``` - ## Methods ### destroy() @@ -221,46 +205,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 646028952e1..0d5b61737ba 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:41](https://github.com/TanStack/query/blob/main/packages/query-core/src/removable.ts#L41) - -#### 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:23](https://github.com/TanStack/query/blob/main/packages/query-core/src/removable.ts#L23) - -#### 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:33](https://github.com/TanStack/query/blob/main/packages/query-core/src/removable.ts#L33) - -#### 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 17a1a23a01f..57e3de53eec 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:7](https://github.com/TanStack/query/blob/main/packages/query-core/src/subscribable.ts#L7) - -#### Inherited from - -```ts -Subscribable.listeners -``` - ## Methods ### build() @@ -369,46 +353,6 @@ Subscribable.hasListeners *** -### onSubscribe() - -```ts -protected onSubscribe(): void; -``` - -Defined in: [packages/query-core/src/subscribable.ts:45](https://github.com/TanStack/query/blob/main/packages/query-core/src/subscribable.ts#L45) - -#### Returns - -`void` - -#### Inherited from - -```ts -Subscribable.onSubscribe -``` - -*** - -### onUnsubscribe() - -```ts -protected onUnsubscribe(): void; -``` - -Defined in: [packages/query-core/src/subscribable.ts:49](https://github.com/TanStack/query/blob/main/packages/query-core/src/subscribable.ts#L49) - -#### 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 c53eb127be8..cb6e073f8ae 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:7](https://github.com/TanStack/query/blob/main/packages/query-core/src/subscribable.ts#L7) - -#### 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 @@ -317,46 +243,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 5cb4d734a07..e6a52b029e0 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() @@ -78,46 +72,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 e98ce5807be..88ec04f62dd 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() @@ -66,46 +60,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 67b5d51aed1..f2173d8bd9a 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:7](https://github.com/TanStack/query/blob/main/packages/query-core/src/subscribable.ts#L7) - -#### Inherited from - -[`QueryObserver`](QueryObserver.md).[`listeners`](QueryObserver.md#listeners) - -*** - ### options ```ts @@ -200,52 +170,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 @@ -457,42 +381,6 @@ Returns `true` while at least one listener is registered, `false` once they have *** -### 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 49975b76a75..f5840cdfd2f 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:41](https://github.com/TanStack/query/blob/main/packages/query-core/src/removable.ts#L41) - -#### Returns - -`void` - -#### Inherited from - -```ts -Removable.clearGcTimeout -``` - -*** - ### continue() ```ts @@ -266,69 +246,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:23](https://github.com/TanStack/query/blob/main/packages/query-core/src/removable.ts#L23) - -#### Returns - -`void` - -#### Inherited from - -```ts -Removable.scheduleGc -``` - -*** - -### updateGcTime() - -```ts -protected updateGcTime(newGcTime: number | undefined): void; -``` - -Defined in: [packages/query-core/src/removable.ts:33](https://github.com/TanStack/query/blob/main/packages/query-core/src/removable.ts#L33) - -#### 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 b64b17cf0e9..b9d3b847527 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:7](https://github.com/TanStack/query/blob/main/packages/query-core/src/subscribable.ts#L7) - -#### Inherited from - -```ts -Subscribable.listeners -``` - ## Methods ### clear() @@ -247,46 +231,6 @@ Subscribable.hasListeners *** -### onSubscribe() - -```ts -protected onSubscribe(): void; -``` - -Defined in: [packages/query-core/src/subscribable.ts:45](https://github.com/TanStack/query/blob/main/packages/query-core/src/subscribable.ts#L45) - -#### Returns - -`void` - -#### Inherited from - -```ts -Subscribable.onSubscribe -``` - -*** - -### onUnsubscribe() - -```ts -protected onUnsubscribe(): void; -``` - -Defined in: [packages/query-core/src/subscribable.ts:49](https://github.com/TanStack/query/blob/main/packages/query-core/src/subscribable.ts#L49) - -#### 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 769317ddfd2..f6ab38a37df 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:7](https://github.com/TanStack/query/blob/main/packages/query-core/src/subscribable.ts#L7) - -#### 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 @@ -198,46 +168,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 3d11965e5b1..a9e663f9a6d 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:7](https://github.com/TanStack/query/blob/main/packages/query-core/src/subscribable.ts#L7) - -#### Inherited from - -```ts -Subscribable.listeners -``` - ## Methods ### destroy() @@ -218,46 +202,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 eca90a14360..7cba080a4b4 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:41](https://github.com/TanStack/query/blob/main/packages/query-core/src/removable.ts#L41) - -#### 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:23](https://github.com/TanStack/query/blob/main/packages/query-core/src/removable.ts#L23) - -#### 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:33](https://github.com/TanStack/query/blob/main/packages/query-core/src/removable.ts#L33) - -#### 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 3648ade0a07..1389882b5de 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:7](https://github.com/TanStack/query/blob/main/packages/query-core/src/subscribable.ts#L7) - -#### Inherited from - -```ts -Subscribable.listeners -``` - ## Methods ### build() @@ -366,46 +350,6 @@ Subscribable.hasListeners *** -### onSubscribe() - -```ts -protected onSubscribe(): void; -``` - -Defined in: [packages/query-core/src/subscribable.ts:45](https://github.com/TanStack/query/blob/main/packages/query-core/src/subscribable.ts#L45) - -#### Returns - -`void` - -#### Inherited from - -```ts -Subscribable.onSubscribe -``` - -*** - -### onUnsubscribe() - -```ts -protected onUnsubscribe(): void; -``` - -Defined in: [packages/query-core/src/subscribable.ts:49](https://github.com/TanStack/query/blob/main/packages/query-core/src/subscribable.ts#L49) - -#### 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 641e19b5b49..8037fb76182 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:7](https://github.com/TanStack/query/blob/main/packages/query-core/src/subscribable.ts#L7) - -#### 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 @@ -314,46 +240,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 c0e6c1dcf22..71c585966d2 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() @@ -75,46 +69,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 e9f911fce4e..1ed3eebcf25 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() @@ -63,46 +57,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 5453760e839..7d48487f0d2 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:7](https://github.com/TanStack/query/blob/main/packages/query-core/src/subscribable.ts#L7) - -#### Inherited from - -[`QueryObserver`](QueryObserver.md).[`listeners`](QueryObserver.md#listeners) - -*** - ### options ```ts @@ -200,52 +170,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 @@ -457,42 +381,6 @@ Returns `true` while at least one listener is registered, `false` once they have *** -### 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 49975b76a75..f5840cdfd2f 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:41](https://github.com/TanStack/query/blob/main/packages/query-core/src/removable.ts#L41) - -#### Returns - -`void` - -#### Inherited from - -```ts -Removable.clearGcTimeout -``` - -*** - ### continue() ```ts @@ -266,69 +246,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:23](https://github.com/TanStack/query/blob/main/packages/query-core/src/removable.ts#L23) - -#### Returns - -`void` - -#### Inherited from - -```ts -Removable.scheduleGc -``` - -*** - -### updateGcTime() - -```ts -protected updateGcTime(newGcTime: number | undefined): void; -``` - -Defined in: [packages/query-core/src/removable.ts:33](https://github.com/TanStack/query/blob/main/packages/query-core/src/removable.ts#L33) - -#### 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 b64b17cf0e9..b9d3b847527 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:7](https://github.com/TanStack/query/blob/main/packages/query-core/src/subscribable.ts#L7) - -#### Inherited from - -```ts -Subscribable.listeners -``` - ## Methods ### clear() @@ -247,46 +231,6 @@ Subscribable.hasListeners *** -### onSubscribe() - -```ts -protected onSubscribe(): void; -``` - -Defined in: [packages/query-core/src/subscribable.ts:45](https://github.com/TanStack/query/blob/main/packages/query-core/src/subscribable.ts#L45) - -#### Returns - -`void` - -#### Inherited from - -```ts -Subscribable.onSubscribe -``` - -*** - -### onUnsubscribe() - -```ts -protected onUnsubscribe(): void; -``` - -Defined in: [packages/query-core/src/subscribable.ts:49](https://github.com/TanStack/query/blob/main/packages/query-core/src/subscribable.ts#L49) - -#### 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 e8ba6146fb3..d8170570502 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:7](https://github.com/TanStack/query/blob/main/packages/query-core/src/subscribable.ts#L7) - -#### 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 @@ -198,46 +168,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 ebcbcd9cc97..ae3ccad54da 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:7](https://github.com/TanStack/query/blob/main/packages/query-core/src/subscribable.ts#L7) - -#### Inherited from - -```ts -Subscribable.listeners -``` - ## Methods ### destroy() @@ -218,46 +202,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 646028952e1..0d5b61737ba 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:41](https://github.com/TanStack/query/blob/main/packages/query-core/src/removable.ts#L41) - -#### 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:23](https://github.com/TanStack/query/blob/main/packages/query-core/src/removable.ts#L23) - -#### 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:33](https://github.com/TanStack/query/blob/main/packages/query-core/src/removable.ts#L33) - -#### 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 18520030db7..cea3b27f19a 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:7](https://github.com/TanStack/query/blob/main/packages/query-core/src/subscribable.ts#L7) - -#### Inherited from - -```ts -Subscribable.listeners -``` - ## Methods ### build() @@ -366,46 +350,6 @@ Subscribable.hasListeners *** -### onSubscribe() - -```ts -protected onSubscribe(): void; -``` - -Defined in: [packages/query-core/src/subscribable.ts:45](https://github.com/TanStack/query/blob/main/packages/query-core/src/subscribable.ts#L45) - -#### Returns - -`void` - -#### Inherited from - -```ts -Subscribable.onSubscribe -``` - -*** - -### onUnsubscribe() - -```ts -protected onUnsubscribe(): void; -``` - -Defined in: [packages/query-core/src/subscribable.ts:49](https://github.com/TanStack/query/blob/main/packages/query-core/src/subscribable.ts#L49) - -#### 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 ba20c873925..4c98810f87b 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:7](https://github.com/TanStack/query/blob/main/packages/query-core/src/subscribable.ts#L7) - -#### 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 @@ -314,46 +240,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 c0e6c1dcf22..71c585966d2 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() @@ -75,46 +69,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 e9f911fce4e..1ed3eebcf25 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() @@ -63,46 +57,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 85aefa3cd2b..00ea3518cc1 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:7](https://github.com/TanStack/query/blob/main/packages/query-core/src/subscribable.ts#L7) - -#### Inherited from - -[`QueryObserver`](QueryObserver.md).[`listeners`](QueryObserver.md#listeners) - -*** - ### options ```ts @@ -200,52 +170,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 @@ -457,42 +381,6 @@ Returns `true` while at least one listener is registered, `false` once they have *** -### 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 49975b76a75..f5840cdfd2f 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:41](https://github.com/TanStack/query/blob/main/packages/query-core/src/removable.ts#L41) - -#### Returns - -`void` - -#### Inherited from - -```ts -Removable.clearGcTimeout -``` - -*** - ### continue() ```ts @@ -266,69 +246,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:23](https://github.com/TanStack/query/blob/main/packages/query-core/src/removable.ts#L23) - -#### Returns - -`void` - -#### Inherited from - -```ts -Removable.scheduleGc -``` - -*** - -### updateGcTime() - -```ts -protected updateGcTime(newGcTime: number | undefined): void; -``` - -Defined in: [packages/query-core/src/removable.ts:33](https://github.com/TanStack/query/blob/main/packages/query-core/src/removable.ts#L33) - -#### 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 00bcfdd16a5..e0fee7525f7 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:7](https://github.com/TanStack/query/blob/main/packages/query-core/src/subscribable.ts#L7) - -#### Inherited from - -```ts -MC.listeners -``` - ## Methods ### clear() @@ -267,46 +251,6 @@ MC.hasListeners *** -### onSubscribe() - -```ts -protected onSubscribe(): void; -``` - -Defined in: [packages/query-core/src/subscribable.ts:45](https://github.com/TanStack/query/blob/main/packages/query-core/src/subscribable.ts#L45) - -#### Returns - -`void` - -#### Inherited from - -```ts -MC.onSubscribe -``` - -*** - -### onUnsubscribe() - -```ts -protected onUnsubscribe(): void; -``` - -Defined in: [packages/query-core/src/subscribable.ts:49](https://github.com/TanStack/query/blob/main/packages/query-core/src/subscribable.ts#L49) - -#### 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 769317ddfd2..f6ab38a37df 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:7](https://github.com/TanStack/query/blob/main/packages/query-core/src/subscribable.ts#L7) - -#### 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 @@ -198,46 +168,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 2b500664849..5384ac3e249 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:7](https://github.com/TanStack/query/blob/main/packages/query-core/src/subscribable.ts#L7) - -#### Inherited from - -```ts -Subscribable.listeners -``` - ## Methods ### destroy() @@ -218,46 +202,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 eca90a14360..7cba080a4b4 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:41](https://github.com/TanStack/query/blob/main/packages/query-core/src/removable.ts#L41) - -#### 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:23](https://github.com/TanStack/query/blob/main/packages/query-core/src/removable.ts#L23) - -#### 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:33](https://github.com/TanStack/query/blob/main/packages/query-core/src/removable.ts#L33) - -#### 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 dd521fe4bd8..58a8ec5f0a5 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:7](https://github.com/TanStack/query/blob/main/packages/query-core/src/subscribable.ts#L7) - -#### Inherited from - -```ts -QC.listeners -``` - ## Methods ### build() @@ -395,46 +379,6 @@ QC.hasListeners *** -### onSubscribe() - -```ts -protected onSubscribe(): void; -``` - -Defined in: [packages/query-core/src/subscribable.ts:45](https://github.com/TanStack/query/blob/main/packages/query-core/src/subscribable.ts#L45) - -#### Returns - -`void` - -#### Inherited from - -```ts -QC.onSubscribe -``` - -*** - -### onUnsubscribe() - -```ts -protected onUnsubscribe(): void; -``` - -Defined in: [packages/query-core/src/subscribable.ts:49](https://github.com/TanStack/query/blob/main/packages/query-core/src/subscribable.ts#L49) - -#### 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 354c5a9494e..684b1ea3d57 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:7](https://github.com/TanStack/query/blob/main/packages/query-core/src/subscribable.ts#L7) - -#### 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 @@ -314,46 +240,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 c0e6c1dcf22..71c585966d2 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() @@ -75,46 +69,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 e9f911fce4e..1ed3eebcf25 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() @@ -63,46 +57,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: