Skip to content
  •  
  •  
  •  
8 changes: 4 additions & 4 deletions docs/framework/angular/reference/classes/CancelledError.md
Original file line number Diff line number Diff line change
Expand Up @@ -59,7 +59,7 @@ Error.constructor
### cause?

```ts
optional cause: unknown;
optional cause?: unknown;
```

Defined in: node\_modules/.pnpm/typescript@6.0.3/node\_modules/typescript/lib/lib.es2022.error.d.ts:24
Expand Down Expand Up @@ -107,7 +107,7 @@ Error.name
### revert?

```ts
optional revert: boolean;
optional revert?: boolean;
```

Defined in: [packages/query-core/src/retryer.ts:121](https://github.com/TanStack/query/blob/main/packages/query-core/src/retryer.ts#L121)
Expand All @@ -117,7 +117,7 @@ Defined in: [packages/query-core/src/retryer.ts:121](https://github.com/TanStack
### silent?

```ts
optional silent: boolean;
optional silent?: boolean;
```

Defined in: [packages/query-core/src/retryer.ts:122](https://github.com/TanStack/query/blob/main/packages/query-core/src/retryer.ts#L122)
Expand All @@ -127,7 +127,7 @@ Defined in: [packages/query-core/src/retryer.ts:122](https://github.com/TanStack
### stack?

```ts
optional stack: string;
optional stack?: string;
```

Defined in: node\_modules/.pnpm/typescript@6.0.3/node\_modules/typescript/lib/lib.es5.d.ts:1076
Expand Down
42 changes: 30 additions & 12 deletions docs/framework/angular/reference/classes/InfiniteQueryObserver.md
Original file line number Diff line number Diff line change
Expand Up @@ -126,7 +126,7 @@ Defined in: [packages/query-core/src/queryObserver.ts:88](https://github.com/Tan

***

### subscribe()
### subscribe

```ts
subscribe: (listener: InfiniteQueryObserverListener) => () => void;
Expand All @@ -150,13 +150,7 @@ Called on each update, with whatever the subclass passes to its subscribers.

A function that removes the listener.

```ts
(): void;
```

##### Returns

`void`
() => `void`

#### Example

Expand Down Expand Up @@ -414,7 +408,7 @@ Returns `true` while at least one listener is registered, `false` once they have
### refetch()

```ts
refetch(options: RefetchOptions): Promise<QueryObserverResult<TData, TError>>;
refetch(options?: RefetchOptions): Promise<QueryObserverResult<TData, TError>>;
```

Defined in: [packages/query-core/src/queryObserver.ts:387](https://github.com/TanStack/query/blob/main/packages/query-core/src/queryObserver.ts#L387)
Expand All @@ -424,7 +418,7 @@ the resulting `QueryObserverResult`.

#### Parameters

##### options
##### options?

[`RefetchOptions`](../interfaces/RefetchOptions.md) = `{}`

Expand Down Expand Up @@ -571,9 +565,33 @@ access themselves (e.g. through their own reactivity system) instead of via the

##### key

The name of the property that was read.
\| `"error"`
\| `"data"`
\| `"isError"`
\| `"isPending"`
\| `"isLoading"`
\| `"isLoadingError"`
\| `"isRefetchError"`
\| `"isSuccess"`
\| `"isPlaceholderData"`
\| `"status"`
\| `"dataUpdatedAt"`
\| `"errorUpdatedAt"`
\| `"failureCount"`
\| `"failureReason"`
\| `"errorUpdateCount"`
\| `"isFetched"`
\| `"isFetchedAfterMount"`
\| `"isFetching"`
\| `"isInitialLoading"`
\| `"isPaused"`
\| `"isRefetching"`
\| `"isStale"`
\| `"isEnabled"`
\| `"refetch"`
\| `"fetchStatus"`

`"error"` | `"data"` | `"isError"` | `"isPending"` | `"isLoading"` | `"isLoadingError"` | `"isRefetchError"` | `"isSuccess"` | `"isPlaceholderData"` | `"status"` | `"dataUpdatedAt"` | `"errorUpdatedAt"` | `"failureCount"` | `"failureReason"` | `"errorUpdateCount"` | `"isFetched"` | `"isFetchedAfterMount"` | `"isFetching"` | `"isInitialLoading"` | `"isPaused"` | `"isRefetching"` | `"isStale"` | `"isEnabled"` | `"refetch"` | `"fetchStatus"`
The name of the property that was read.

#### Returns

Expand Down
16 changes: 5 additions & 11 deletions docs/framework/angular/reference/classes/MutationCache.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,14 +28,14 @@ const unsubscribe = mutationCache.subscribe((event) => {
### Constructor

```ts
new MutationCache(config: MutationCacheConfig): MutationCache;
new MutationCache(config?: MutationCacheConfig): MutationCache;
```

Defined in: [packages/query-core/src/mutationCache.ts:128](https://github.com/TanStack/query/blob/main/packages/query-core/src/mutationCache.ts#L128)

#### Parameters

##### config
##### config?

[`MutationCacheConfig`](../interfaces/MutationCacheConfig.md) = `{}`

Expand Down Expand Up @@ -151,7 +151,7 @@ const mutation = mutationCache.find({ mutationKey: ['addPost'] })
### findAll()

```ts
findAll(filters: MutationFilters): Mutation<unknown, Error, unknown, unknown>[];
findAll(filters?: MutationFilters): Mutation<unknown, Error, unknown, unknown>[];
```

Defined in: [packages/query-core/src/mutationCache.ts:336](https://github.com/TanStack/query/blob/main/packages/query-core/src/mutationCache.ts#L336)
Expand All @@ -164,7 +164,7 @@ information about mutations in rare scenarios.

#### Parameters

##### filters
##### filters?

[`MutationFilters`](../interfaces/MutationFilters.md) = `{}`

Expand Down Expand Up @@ -267,13 +267,7 @@ Called on each update, with whatever the subclass passes to its subscribers.

A function that removes the listener.

```ts
(): void;
```

##### Returns

`void`
() => `void`

#### Example

Expand Down
8 changes: 1 addition & 7 deletions docs/framework/angular/reference/classes/MutationObserver.md
Original file line number Diff line number Diff line change
Expand Up @@ -272,13 +272,7 @@ Called on each update, with whatever the subclass passes to its subscribers.

A function that removes the listener.

```ts
(): void;
```

##### Returns

`void`
() => `void`

#### Example

Expand Down
12 changes: 3 additions & 9 deletions docs/framework/angular/reference/classes/QueriesObserver.md
Original file line number Diff line number Diff line change
Expand Up @@ -161,9 +161,9 @@ The defaulted options of the queries to compute the result for.

##### combine

The `combine` function used by the returned `combineResult`, if any.
`CombineFn`\<`TCombinedResult`\> \| `undefined`

`CombineFn`\<`TCombinedResult`\> | `undefined`
The `combine` function used by the returned `combineResult`, if any.

#### Returns

Expand Down Expand Up @@ -283,13 +283,7 @@ Called on each update, with whatever the subclass passes to its subscribers.

A function that removes the listener.

```ts
(): void;
```

##### Returns

`void`
() => `void`

#### Example

Expand Down
8 changes: 4 additions & 4 deletions docs/framework/angular/reference/classes/Query.md
Original file line number Diff line number Diff line change
Expand Up @@ -436,7 +436,7 @@ if (query.isStale()) {
### isStaleByTime()

```ts
isStaleByTime(staleTime: number | "static"): boolean;
isStaleByTime(staleTime?: number | "static"): boolean;
```

Defined in: [packages/query-core/src/query.ts:561](https://github.com/TanStack/query/blob/main/packages/query-core/src/query.ts#L561)
Expand All @@ -450,13 +450,13 @@ Returns `true` if the query's data is stale relative to the given

#### Parameters

##### staleTime
##### staleTime?

`number` \| `"static"`

The time, in milliseconds, after which data is considered stale, or
`'static'` to never treat existing data as stale. A query without data is stale either way.

`number` | `"static"`

#### Returns

`boolean`
Expand Down
16 changes: 5 additions & 11 deletions docs/framework/angular/reference/classes/QueryCache.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,14 +31,14 @@ const unsubscribe = queryCache.subscribe((event) => {
### Constructor

```ts
new QueryCache(config: QueryCacheConfig): QueryCache;
new QueryCache(config?: QueryCacheConfig): QueryCache;
```

Defined in: [packages/query-core/src/queryCache.ts:143](https://github.com/TanStack/query/blob/main/packages/query-core/src/queryCache.ts#L143)

#### Parameters

##### config
##### config?

[`QueryCacheConfig`](../interfaces/QueryCacheConfig.md) = `{}`

Expand Down Expand Up @@ -229,7 +229,7 @@ const query = queryCache.find({ queryKey: ['posts'] })
### findAll()

```ts
findAll(filters: QueryFilters<any>): Query<unknown, Error, unknown, readonly unknown[]>[];
findAll(filters?: QueryFilters<any>): Query<unknown, Error, unknown, readonly unknown[]>[];
```

Defined in: [packages/query-core/src/queryCache.ts:349](https://github.com/TanStack/query/blob/main/packages/query-core/src/queryCache.ts#L349)
Expand All @@ -242,7 +242,7 @@ information about queries in rare scenarios.

#### Parameters

##### filters
##### filters?

[`QueryFilters`](../interfaces/QueryFilters.md)\<`any`\> = `{}`

Expand Down Expand Up @@ -439,13 +439,7 @@ Called on each update, with whatever the subclass passes to its subscribers.

A function that removes the listener.

```ts
(): void;
```

##### Returns

`void`
() => `void`

#### Example

Expand Down
9 changes: 5 additions & 4 deletions docs/framework/angular/reference/classes/QueryClient.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,14 +28,14 @@ await queryClient.query({ queryKey: ['posts'], queryFn: fetchPosts })
### Constructor

```ts
new QueryClient(config: QueryClientConfig): QueryClient;
new QueryClient(config?: QueryClientConfig): QueryClient;
```

Defined in: [packages/query-core/src/queryClient.ts:88](https://github.com/TanStack/query/blob/main/packages/query-core/src/queryClient.ts#L88)

#### Parameters

##### config
##### config?

[`QueryClientConfig`](../interfaces/QueryClientConfig.md) = `{}`

Expand Down Expand Up @@ -201,9 +201,10 @@ top. A no-op if the options are already defaulted (`_defaulted: true`).

##### options

The query options passed by the caller.
\| [`QueryObserverOptions`](../interfaces/QueryObserverOptions.md)\<`TQueryFnData`, `TError`, `TData`, `TQueryData`, `TQueryKey`, `TPageParam`\>
\| [`DefaultedQueryObserverOptions`](../type-aliases/DefaultedQueryObserverOptions.md)\<`TQueryFnData`, `TError`, `TData`, `TQueryData`, `TQueryKey`\>

[`QueryObserverOptions`](../interfaces/QueryObserverOptions.md)\<`TQueryFnData`, `TError`, `TData`, `TQueryData`, `TQueryKey`, `TPageParam`\> | [`DefaultedQueryObserverOptions`](../type-aliases/DefaultedQueryObserverOptions.md)\<`TQueryFnData`, `TError`, `TData`, `TQueryData`, `TQueryKey`\>
The query options passed by the caller.

#### Returns

Expand Down
40 changes: 29 additions & 11 deletions docs/framework/angular/reference/classes/QueryObserver.md
Original file line number Diff line number Diff line change
Expand Up @@ -257,7 +257,7 @@ Subscribable.hasListeners
### refetch()

```ts
refetch(options: RefetchOptions): Promise<QueryObserverResult<TData, TError>>;
refetch(options?: RefetchOptions): Promise<QueryObserverResult<TData, TError>>;
```

Defined in: [packages/query-core/src/queryObserver.ts:387](https://github.com/TanStack/query/blob/main/packages/query-core/src/queryObserver.ts#L387)
Expand All @@ -267,7 +267,7 @@ the resulting `QueryObserverResult`.

#### Parameters

##### options
##### options?

[`RefetchOptions`](../interfaces/RefetchOptions.md) = `{}`

Expand Down Expand Up @@ -393,13 +393,7 @@ Called on each update, with whatever the subclass passes to its subscribers.

A function that removes the listener.

```ts
(): void;
```

##### Returns

`void`
() => `void`

#### Example

Expand Down Expand Up @@ -461,9 +455,33 @@ access themselves (e.g. through their own reactivity system) instead of via the

##### key

The name of the property that was read.
\| `"error"`
\| `"data"`
\| `"isError"`
\| `"isPending"`
\| `"isLoading"`
\| `"isLoadingError"`
\| `"isRefetchError"`
\| `"isSuccess"`
\| `"isPlaceholderData"`
\| `"status"`
\| `"dataUpdatedAt"`
\| `"errorUpdatedAt"`
\| `"failureCount"`
\| `"failureReason"`
\| `"errorUpdateCount"`
\| `"isFetched"`
\| `"isFetchedAfterMount"`
\| `"isFetching"`
\| `"isInitialLoading"`
\| `"isPaused"`
\| `"isRefetching"`
\| `"isStale"`
\| `"isEnabled"`
\| `"refetch"`
\| `"fetchStatus"`

`"error"` | `"data"` | `"isError"` | `"isPending"` | `"isLoading"` | `"isLoadingError"` | `"isRefetchError"` | `"isSuccess"` | `"isPlaceholderData"` | `"status"` | `"dataUpdatedAt"` | `"errorUpdatedAt"` | `"failureCount"` | `"failureReason"` | `"errorUpdateCount"` | `"isFetched"` | `"isFetchedAfterMount"` | `"isFetching"` | `"isInitialLoading"` | `"isPaused"` | `"isRefetching"` | `"isStale"` | `"isEnabled"` | `"refetch"` | `"fetchStatus"`
The name of the property that was read.

#### Returns

Expand Down
4 changes: 2 additions & 2 deletions docs/framework/angular/reference/functions/dehydrate.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ title: dehydrate
---

```ts
function dehydrate(client: QueryClient, options: DehydrateOptions): DehydratedState;
function dehydrate(client: QueryClient, options?: DehydrateOptions): DehydratedState;
```

Defined in: [packages/query-core/src/hydration.ts:245](https://github.com/TanStack/query/blob/main/packages/query-core/src/hydration.ts#L245)
Expand All @@ -23,7 +23,7 @@ falling back to the client's `dehydrate` default options, and finally to `defaul

The client whose cache is dehydrated.

### options
### options?

[`DehydrateOptions`](../interfaces/DehydrateOptions.md) = `{}`

Expand Down
Loading
Loading