Skip to content

docs(*): exclude protected members from generated reference docs #11564

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
sukvvon merged 4 commits into from
Sep 23, 2026
Merged

docs(*): exclude protected members from generated reference docs #11564

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
53bf4d3
docs(*): exclude protected members from generated reference docs
sukvvon Sep 21, 2026
231b630
Merge branch 'main' into docs/exclude-protected-from-reference
sukvvon Sep 22, 2026
badf19c
Merge remote-tracking branch 'origin/main' into docs/exclude-protecte…
sukvvon Sep 22, 2026
68f9453
Merge branch 'main' into docs/exclude-protected-from-reference
sukvvon Sep 23, 2026
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
112 changes: 0 additions & 112 deletions docs/framework/angular/reference/classes/InfiniteQueryObserver.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -80,22 +80,6 @@ Defined in: [packages/query-core/src/infiniteQueryObserver.ts:83](https://github

## Properties

### fetch

```ts
protected fetch: ReplaceReturnType<(fetchOptions: ObserverFetchOptions) => Promise<QueryObserverResult<TData, TError>>, Promise<InfiniteQueryObserverResult<TData, TError>>>;
```

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
Expand Down Expand Up @@ -124,20 +108,6 @@ QueryObserver.getCurrentResult

***

### listeners

```ts
protected listeners: Set<QueryObserverListener<TData, TError>>;
```

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
Expand Down Expand Up @@ -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<TQueryFnData, TError, InfiniteData<TQueryFnData, TPageParam>, TQueryKey>, options: InfiniteQueryObserverOptions<TQueryFnData, TError, TData, TQueryKey, TPageParam>): InfiniteQueryObserverResult<TData, TError>;
```

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
Expand Down Expand Up @@ -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
Expand Down
86 changes: 0 additions & 86 deletions docs/framework/angular/reference/classes/Mutation.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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
```
56 changes: 0 additions & 56 deletions docs/framework/angular/reference/classes/MutationCache.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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<MutationCacheListener>;
```

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()
Expand Down Expand Up @@ -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
Expand Down
70 changes: 0 additions & 70 deletions docs/framework/angular/reference/classes/MutationObserver.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -76,22 +76,6 @@ Subscribable<

## Properties

### listeners

```ts
protected listeners: Set<MutationObserverListener<TData, TError, TVariables, TOnMutateResult>>;
```

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
Expand All @@ -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
Expand Down Expand Up @@ -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
Expand Down
Loading
Loading