Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 20 additions & 2 deletions docs/framework/angular/reference/classes/InfiniteQueryObserver.md
Original file line number Diff line number Diff line change
Expand Up @@ -130,7 +130,7 @@ QueryObserver.getCurrentResult
protected listeners: Set<QueryObserverListener<TData, TError>>;
```

Defined in: [packages/query-core/src/subscribable.ts:2](https://github.com/TanStack/query/blob/main/packages/query-core/src/subscribable.ts#L2)
Defined in: [packages/query-core/src/subscribable.ts:7](https://github.com/TanStack/query/blob/main/packages/query-core/src/subscribable.ts#L7)

#### Inherited from

Expand Down Expand Up @@ -160,12 +160,18 @@ subscribe: (listener: InfiniteQueryObserverListener) => () => void;

Defined in: [packages/query-core/src/infiniteQueryObserver.ts:55](https://github.com/TanStack/query/blob/main/packages/query-core/src/infiniteQueryObserver.ts#L55)

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

#### Parameters

##### listener

`InfiniteQueryObserverListener`

Called on each update, with whatever the subclass passes to its subscribers.

#### Returns

```ts
Expand All @@ -176,6 +182,16 @@ Defined in: [packages/query-core/src/infiniteQueryObserver.ts:55](https://github

`void`

#### Example

```ts
const unsubscribe = subscribable.subscribe(() => {
// react to the update
})

unsubscribe()
```

#### Overrides

```ts
Expand Down Expand Up @@ -427,7 +443,9 @@ synchronously.
hasListeners(): boolean;
```

Defined in: [packages/query-core/src/subscribable.ts:19](https://github.com/TanStack/query/blob/main/packages/query-core/src/subscribable.ts#L19)
Defined in: [packages/query-core/src/subscribable.ts:41](https://github.com/TanStack/query/blob/main/packages/query-core/src/subscribable.ts#L41)

Returns `true` while at least one listener is registered, `false` once they have all unsubscribed.

#### Returns

Expand Down
14 changes: 9 additions & 5 deletions docs/framework/angular/reference/classes/Mutation.md
Original file line number Diff line number Diff line change
Expand Up @@ -78,7 +78,7 @@ Removable.constructor
gcTime: number;
```

Defined in: [packages/query-core/src/removable.ts:7](https://github.com/TanStack/query/blob/main/packages/query-core/src/removable.ts#L7)
Defined in: [packages/query-core/src/removable.ts:11](https://github.com/TanStack/query/blob/main/packages/query-core/src/removable.ts#L11)

#### Inherited from

Expand Down Expand Up @@ -142,7 +142,7 @@ The `meta` object passed in the mutation's options, if any.
protected clearGcTimeout(): void;
```

Defined in: [packages/query-core/src/removable.ts:32](https://github.com/TanStack/query/blob/main/packages/query-core/src/removable.ts#L32)
Defined in: [packages/query-core/src/removable.ts:41](https://github.com/TanStack/query/blob/main/packages/query-core/src/removable.ts#L41)

#### Returns

Expand Down Expand Up @@ -199,7 +199,11 @@ await mutation?.continue()
destroy(): void;
```

Defined in: [packages/query-core/src/removable.ts:10](https://github.com/TanStack/query/blob/main/packages/query-core/src/removable.ts#L10)
Defined in: [packages/query-core/src/removable.ts:19](https://github.com/TanStack/query/blob/main/packages/query-core/src/removable.ts#L19)

Clears the pending garbage collection timeout, so the entry is no longer scheduled for removal.
A subclass may override this to release what it holds on to as well β€” `Query` also cancels any
in-flight fetch.

#### Returns

Expand Down Expand Up @@ -291,7 +295,7 @@ Removable.optionalRemove
protected scheduleGc(): void;
```

Defined in: [packages/query-core/src/removable.ts:14](https://github.com/TanStack/query/blob/main/packages/query-core/src/removable.ts#L14)
Defined in: [packages/query-core/src/removable.ts:23](https://github.com/TanStack/query/blob/main/packages/query-core/src/removable.ts#L23)

#### Returns

Expand All @@ -311,7 +315,7 @@ Removable.scheduleGc
protected updateGcTime(newGcTime: number | undefined): void;
```

Defined in: [packages/query-core/src/removable.ts:24](https://github.com/TanStack/query/blob/main/packages/query-core/src/removable.ts#L24)
Defined in: [packages/query-core/src/removable.ts:33](https://github.com/TanStack/query/blob/main/packages/query-core/src/removable.ts#L33)

#### Parameters

Expand Down
28 changes: 23 additions & 5 deletions docs/framework/angular/reference/classes/MutationCache.md
Original file line number Diff line number Diff line change
Expand Up @@ -67,7 +67,7 @@ Defined in: [packages/query-core/src/mutationCache.ts:129](https://github.com/Ta
protected listeners: Set<MutationCacheListener>;
```

Defined in: [packages/query-core/src/subscribable.ts:2](https://github.com/TanStack/query/blob/main/packages/query-core/src/subscribable.ts#L2)
Defined in: [packages/query-core/src/subscribable.ts:7](https://github.com/TanStack/query/blob/main/packages/query-core/src/subscribable.ts#L7)

#### Inherited from

Expand Down Expand Up @@ -231,7 +231,9 @@ const mutations = mutationCache.getAll()
hasListeners(): boolean;
```

Defined in: [packages/query-core/src/subscribable.ts:19](https://github.com/TanStack/query/blob/main/packages/query-core/src/subscribable.ts#L19)
Defined in: [packages/query-core/src/subscribable.ts:41](https://github.com/TanStack/query/blob/main/packages/query-core/src/subscribable.ts#L41)

Returns `true` while at least one listener is registered, `false` once they have all unsubscribed.

#### Returns

Expand All @@ -251,7 +253,7 @@ Subscribable.hasListeners
protected onSubscribe(): void;
```

Defined in: [packages/query-core/src/subscribable.ts:23](https://github.com/TanStack/query/blob/main/packages/query-core/src/subscribable.ts#L23)
Defined in: [packages/query-core/src/subscribable.ts:45](https://github.com/TanStack/query/blob/main/packages/query-core/src/subscribable.ts#L45)

#### Returns

Expand All @@ -271,7 +273,7 @@ Subscribable.onSubscribe
protected onUnsubscribe(): void;
```

Defined in: [packages/query-core/src/subscribable.ts:27](https://github.com/TanStack/query/blob/main/packages/query-core/src/subscribable.ts#L27)
Defined in: [packages/query-core/src/subscribable.ts:49](https://github.com/TanStack/query/blob/main/packages/query-core/src/subscribable.ts#L49)

#### Returns

Expand All @@ -291,14 +293,20 @@ Subscribable.onUnsubscribe
subscribe(listener: MutationCacheListener): () => void;
```

Defined in: [packages/query-core/src/subscribable.ts:8](https://github.com/TanStack/query/blob/main/packages/query-core/src/subscribable.ts#L8)
Defined in: [packages/query-core/src/subscribable.ts:27](https://github.com/TanStack/query/blob/main/packages/query-core/src/subscribable.ts#L27)

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

#### Parameters

##### listener

`MutationCacheListener`

Called on each update, with whatever the subclass passes to its subscribers.

#### Returns

```ts
Expand All @@ -309,6 +317,16 @@ Defined in: [packages/query-core/src/subscribable.ts:8](https://github.com/TanSt

`void`

#### Example

```ts
const unsubscribe = subscribable.subscribe(() => {
// react to the update
})

unsubscribe()
```

#### Inherited from

```ts
Expand Down
24 changes: 21 additions & 3 deletions docs/framework/angular/reference/classes/MutationObserver.md
Original file line number Diff line number Diff line change
Expand Up @@ -82,7 +82,7 @@ Subscribable<
protected listeners: Set<MutationObserverListener<TData, TError, TVariables, TOnMutateResult>>;
```

Defined in: [packages/query-core/src/subscribable.ts:2](https://github.com/TanStack/query/blob/main/packages/query-core/src/subscribable.ts#L2)
Defined in: [packages/query-core/src/subscribable.ts:7](https://github.com/TanStack/query/blob/main/packages/query-core/src/subscribable.ts#L7)

#### Inherited from

Expand Down Expand Up @@ -140,7 +140,9 @@ built yet, e.g. before the first `mutate()` call or after `reset()`).
hasListeners(): boolean;
```

Defined in: [packages/query-core/src/subscribable.ts:19](https://github.com/TanStack/query/blob/main/packages/query-core/src/subscribable.ts#L19)
Defined in: [packages/query-core/src/subscribable.ts:41](https://github.com/TanStack/query/blob/main/packages/query-core/src/subscribable.ts#L41)

Returns `true` while at least one listener is registered, `false` once they have all unsubscribed.

#### Returns

Expand Down Expand Up @@ -310,14 +312,20 @@ observer.setOptions({
subscribe(listener: MutationObserverListener): () => void;
```

Defined in: [packages/query-core/src/subscribable.ts:8](https://github.com/TanStack/query/blob/main/packages/query-core/src/subscribable.ts#L8)
Defined in: [packages/query-core/src/subscribable.ts:27](https://github.com/TanStack/query/blob/main/packages/query-core/src/subscribable.ts#L27)

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

#### Parameters

##### listener

`MutationObserverListener`

Called on each update, with whatever the subclass passes to its subscribers.

#### Returns

```ts
Expand All @@ -328,6 +336,16 @@ Defined in: [packages/query-core/src/subscribable.ts:8](https://github.com/TanSt

`void`

#### Example

```ts
const unsubscribe = subscribable.subscribe(() => {
// react to the update
})

unsubscribe()
```

#### Inherited from

```ts
Expand Down
24 changes: 21 additions & 3 deletions docs/framework/angular/reference/classes/QueriesObserver.md
Original file line number Diff line number Diff line change
Expand Up @@ -79,7 +79,7 @@ Subscribable<QueriesObserverListener>.constructor
protected listeners: Set<QueriesObserverListener>;
```

Defined in: [packages/query-core/src/subscribable.ts:2](https://github.com/TanStack/query/blob/main/packages/query-core/src/subscribable.ts#L2)
Defined in: [packages/query-core/src/subscribable.ts:7](https://github.com/TanStack/query/blob/main/packages/query-core/src/subscribable.ts#L7)

#### Inherited from

Expand Down Expand Up @@ -202,7 +202,9 @@ the same order as the queries passed to the constructor or `setQueries`.
hasListeners(): boolean;
```

Defined in: [packages/query-core/src/subscribable.ts:19](https://github.com/TanStack/query/blob/main/packages/query-core/src/subscribable.ts#L19)
Defined in: [packages/query-core/src/subscribable.ts:41](https://github.com/TanStack/query/blob/main/packages/query-core/src/subscribable.ts#L41)

Returns `true` while at least one listener is registered, `false` once they have all unsubscribed.

#### Returns

Expand Down Expand Up @@ -300,14 +302,20 @@ observer.setQueries([
subscribe(listener: QueriesObserverListener): () => void;
```

Defined in: [packages/query-core/src/subscribable.ts:8](https://github.com/TanStack/query/blob/main/packages/query-core/src/subscribable.ts#L8)
Defined in: [packages/query-core/src/subscribable.ts:27](https://github.com/TanStack/query/blob/main/packages/query-core/src/subscribable.ts#L27)

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

#### Parameters

##### listener

`QueriesObserverListener`

Called on each update, with whatever the subclass passes to its subscribers.

#### Returns

```ts
Expand All @@ -318,6 +326,16 @@ Defined in: [packages/query-core/src/subscribable.ts:8](https://github.com/TanSt

`void`

#### Example

```ts
const unsubscribe = subscribable.subscribe(() => {
// react to the update
})

unsubscribe()
```

#### Inherited from

```ts
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 @@ -80,7 +80,7 @@ Removable.constructor
gcTime: number;
```

Defined in: [packages/query-core/src/removable.ts:7](https://github.com/TanStack/query/blob/main/packages/query-core/src/removable.ts#L7)
Defined in: [packages/query-core/src/removable.ts:11](https://github.com/TanStack/query/blob/main/packages/query-core/src/removable.ts#L11)

#### Inherited from

Expand Down Expand Up @@ -213,7 +213,7 @@ await query.cancel()
protected clearGcTimeout(): void;
```

Defined in: [packages/query-core/src/removable.ts:32](https://github.com/TanStack/query/blob/main/packages/query-core/src/removable.ts#L32)
Defined in: [packages/query-core/src/removable.ts:41](https://github.com/TanStack/query/blob/main/packages/query-core/src/removable.ts#L41)

#### Returns

Expand Down Expand Up @@ -522,7 +522,7 @@ in-flight fetch.
protected scheduleGc(): void;
```

Defined in: [packages/query-core/src/removable.ts:14](https://github.com/TanStack/query/blob/main/packages/query-core/src/removable.ts#L14)
Defined in: [packages/query-core/src/removable.ts:23](https://github.com/TanStack/query/blob/main/packages/query-core/src/removable.ts#L23)

#### Returns

Expand Down Expand Up @@ -566,7 +566,7 @@ user manually trigger a loading/error state or edit the cached data.
protected updateGcTime(newGcTime: number | undefined): void;
```

Defined in: [packages/query-core/src/removable.ts:24](https://github.com/TanStack/query/blob/main/packages/query-core/src/removable.ts#L24)
Defined in: [packages/query-core/src/removable.ts:33](https://github.com/TanStack/query/blob/main/packages/query-core/src/removable.ts#L33)

#### Parameters

Expand Down
Loading
Loading