Skip to content

Commit ddf6b80

Browse files
arnoud-dvarnoud-dv
authored
refactor(angular-query): rename DeveloperToolsFeature to DevtoolsFeature (#9794)
1 parent 1e77bd4 commit ddf6b80

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

45 files changed

+171
-535
lines changed

‎.changeset/devtools-feature-rename.md‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
---
2+
'@tanstack/angular-query-experimental': patch
3+
---
4+
5+
Rename `DeveloperToolsFeature` to `DevtoolsFeature` for consistency with internal naming conventions and ecosystem

‎.prettierignore‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,3 +9,4 @@
99
pnpm-lock.yaml
1010
packages/**/tsup.config.bundled*.mjs
1111
**/tsconfig.vitest-temp.json
12+
docs/framework/*/reference

‎docs/framework/angular/reference/functions/infinitequeryoptions.md‎

Lines changed: 6 additions & 57 deletions
Original file line numberDiff line numberDiff line change
@@ -18,23 +18,7 @@ The infinite query options to tag with the type from `queryFn`.
1818
## Call Signature
1919

2020
```ts
21-
function infiniteQueryOptions<
22-
TQueryFnData,
23-
TError,
24-
TData,
25-
TQueryKey,
26-
TPageParam,
27-
>(
28-
options,
29-
): CreateInfiniteQueryOptions<
30-
TQueryFnData,
31-
TError,
32-
TData,
33-
TQueryKey,
34-
TPageParam
35-
> &
36-
object &
37-
object
21+
function infiniteQueryOptions<TQueryFnData, TError, TData, TQueryKey, TPageParam>(options): CreateInfiniteQueryOptions<TQueryFnData, TError, TData, TQueryKey, TPageParam> & object & object
3822
```
3923

4024
Defined in: [infinite-query-options.ts:88](https://github.com/TanStack/query/blob/main/packages/angular-query-experimental/src/infinite-query-options.ts#L88)
@@ -51,7 +35,7 @@ The `queryKey` will be tagged with the type from `queryFn`.
5135

5236
• **TData** = `InfiniteData`\<`TQueryFnData`, `unknown`\>
5337

54-
• **TQueryKey** _extends_ readonly `unknown`[] = readonly `unknown`[]
38+
• **TQueryKey** *extends* readonly `unknown`[] = readonly `unknown`[]
5539

5640
• **TPageParam** = `unknown`
5741

@@ -78,26 +62,7 @@ The infinite query options to tag with the type from `queryFn`.
7862
## Call Signature
7963

8064
```ts
81-
function infiniteQueryOptions<
82-
TQueryFnData,
83-
TError,
84-
TData,
85-
TQueryKey,
86-
TPageParam,
87-
>(
88-
options,
89-
): OmitKeyof<
90-
CreateInfiniteQueryOptions<
91-
TQueryFnData,
92-
TError,
93-
TData,
94-
TQueryKey,
95-
TPageParam
96-
>,
97-
'queryFn'
98-
> &
99-
object &
100-
object
65+
function infiniteQueryOptions<TQueryFnData, TError, TData, TQueryKey, TPageParam>(options): OmitKeyof<CreateInfiniteQueryOptions<TQueryFnData, TError, TData, TQueryKey, TPageParam>, "queryFn"> & object & object
10166
```
10267

10368
Defined in: [infinite-query-options.ts:119](https://github.com/TanStack/query/blob/main/packages/angular-query-experimental/src/infinite-query-options.ts#L119)
@@ -114,7 +79,7 @@ The `queryKey` will be tagged with the type from `queryFn`.
11479

11580
• **TData** = `InfiniteData`\<`TQueryFnData`, `unknown`\>
11681

117-
• **TQueryKey** _extends_ readonly `unknown`[] = readonly `unknown`[]
82+
• **TQueryKey** *extends* readonly `unknown`[] = readonly `unknown`[]
11883

11984
• **TPageParam** = `unknown`
12085

@@ -141,23 +106,7 @@ The infinite query options to tag with the type from `queryFn`.
141106
## Call Signature
142107

143108
```ts
144-
function infiniteQueryOptions<
145-
TQueryFnData,
146-
TError,
147-
TData,
148-
TQueryKey,
149-
TPageParam,
150-
>(
151-
options,
152-
): CreateInfiniteQueryOptions<
153-
TQueryFnData,
154-
TError,
155-
TData,
156-
TQueryKey,
157-
TPageParam
158-
> &
159-
object &
160-
object
109+
function infiniteQueryOptions<TQueryFnData, TError, TData, TQueryKey, TPageParam>(options): CreateInfiniteQueryOptions<TQueryFnData, TError, TData, TQueryKey, TPageParam> & object & object
161110
```
162111

163112
Defined in: [infinite-query-options.ts:150](https://github.com/TanStack/query/blob/main/packages/angular-query-experimental/src/infinite-query-options.ts#L150)
@@ -174,7 +123,7 @@ The `queryKey` will be tagged with the type from `queryFn`.
174123

175124
• **TData** = `InfiniteData`\<`TQueryFnData`, `unknown`\>
176125

177-
• **TQueryKey** _extends_ readonly `unknown`[] = readonly `unknown`[]
126+
• **TQueryKey** *extends* readonly `unknown`[] = readonly `unknown`[]
178127

179128
• **TPageParam** = `unknown`
180129

‎docs/framework/angular/reference/functions/injectinfinitequery.md‎

Lines changed: 6 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -21,16 +21,7 @@ Additional configuration.
2121
## Call Signature
2222

2323
```ts
24-
function injectInfiniteQuery<
25-
TQueryFnData,
26-
TError,
27-
TData,
28-
TQueryKey,
29-
TPageParam,
30-
>(
31-
injectInfiniteQueryFn,
32-
options?,
33-
): DefinedCreateInfiniteQueryResult<TData, TError>
24+
function injectInfiniteQuery<TQueryFnData, TError, TData, TQueryKey, TPageParam>(injectInfiniteQueryFn, options?): DefinedCreateInfiniteQueryResult<TData, TError>
3425
```
3526

3627
Defined in: [inject-infinite-query.ts:41](https://github.com/TanStack/query/blob/main/packages/angular-query-experimental/src/inject-infinite-query.ts#L41)
@@ -46,7 +37,7 @@ Infinite queries can additively "load more" data onto an existing set of data or
4637

4738
• **TData** = `InfiniteData`\<`TQueryFnData`, `unknown`\>
4839

49-
• **TQueryKey** _extends_ readonly `unknown`[] = readonly `unknown`[]
40+
• **TQueryKey** *extends* readonly `unknown`[] = readonly `unknown`[]
5041

5142
• **TPageParam** = `unknown`
5243

@@ -83,13 +74,7 @@ Additional configuration.
8374
## Call Signature
8475

8576
```ts
86-
function injectInfiniteQuery<
87-
TQueryFnData,
88-
TError,
89-
TData,
90-
TQueryKey,
91-
TPageParam,
92-
>(injectInfiniteQueryFn, options?): CreateInfiniteQueryResult<TData, TError>
77+
function injectInfiniteQuery<TQueryFnData, TError, TData, TQueryKey, TPageParam>(injectInfiniteQueryFn, options?): CreateInfiniteQueryResult<TData, TError>
9378
```
9479

9580
Defined in: [inject-infinite-query.ts:65](https://github.com/TanStack/query/blob/main/packages/angular-query-experimental/src/inject-infinite-query.ts#L65)
@@ -105,7 +90,7 @@ Infinite queries can additively "load more" data onto an existing set of data or
10590

10691
• **TData** = `InfiniteData`\<`TQueryFnData`, `unknown`\>
10792

108-
• **TQueryKey** _extends_ readonly `unknown`[] = readonly `unknown`[]
93+
• **TQueryKey** *extends* readonly `unknown`[] = readonly `unknown`[]
10994

11095
• **TPageParam** = `unknown`
11196

@@ -142,13 +127,7 @@ Additional configuration.
142127
## Call Signature
143128

144129
```ts
145-
function injectInfiniteQuery<
146-
TQueryFnData,
147-
TError,
148-
TData,
149-
TQueryKey,
150-
TPageParam,
151-
>(injectInfiniteQueryFn, options?): CreateInfiniteQueryResult<TData, TError>
130+
function injectInfiniteQuery<TQueryFnData, TError, TData, TQueryKey, TPageParam>(injectInfiniteQueryFn, options?): CreateInfiniteQueryResult<TData, TError>
152131
```
153132

154133
Defined in: [inject-infinite-query.ts:89](https://github.com/TanStack/query/blob/main/packages/angular-query-experimental/src/inject-infinite-query.ts#L89)
@@ -164,7 +143,7 @@ Infinite queries can additively "load more" data onto an existing set of data or
164143

165144
• **TData** = `InfiniteData`\<`TQueryFnData`, `unknown`\>
166145

167-
• **TQueryKey** _extends_ readonly `unknown`[] = readonly `unknown`[]
146+
• **TQueryKey** *extends* readonly `unknown`[] = readonly `unknown`[]
168147

169148
• **TPageParam** = `unknown`
170149

‎docs/framework/angular/reference/functions/injectisfetching.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ title: injectIsFetching
1111
function injectIsFetching(filters?, options?): Signal<number>
1212
```
1313

14-
Defined in: [inject-is-fetching.ts:32](https://github.com/TanStack/query/blob/main/packages/angular-query-experimental/src/inject-is-fetching.ts#L32)
14+
Defined in: [inject-is-fetching.ts:31](https://github.com/TanStack/query/blob/main/packages/angular-query-experimental/src/inject-is-fetching.ts#L31)
1515

1616
Injects a signal that tracks the number of queries that your application is loading or
1717
fetching in the background.

‎docs/framework/angular/reference/functions/injectmutation.md‎

Lines changed: 2 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -8,13 +8,10 @@ title: injectMutation
88
# Function: injectMutation()
99

1010
```ts
11-
function injectMutation<TData, TError, TVariables, TOnMutateResult>(
12-
injectMutationFn,
13-
options?,
14-
): CreateMutationResult<TData, TError, TVariables, TOnMutateResult>
11+
function injectMutation<TData, TError, TVariables, TOnMutateResult>(injectMutationFn, options?): CreateMutationResult<TData, TError, TVariables, TOnMutateResult>
1512
```
1613

17-
Defined in: [inject-mutation.ts:44](https://github.com/TanStack/query/blob/main/packages/angular-query-experimental/src/inject-mutation.ts#L44)
14+
Defined in: [inject-mutation.ts:45](https://github.com/TanStack/query/blob/main/packages/angular-query-experimental/src/inject-mutation.ts#L45)
1815

1916
Injects a mutation: an imperative function that can be invoked which typically performs server side effects.
2017

‎docs/framework/angular/reference/functions/injectmutationstate.md‎

Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -8,10 +8,7 @@ title: injectMutationState
88
# Function: injectMutationState()
99

1010
```ts
11-
function injectMutationState<TResult>(
12-
injectMutationStateFn,
13-
options?,
14-
): Signal<TResult[]>
11+
function injectMutationState<TResult>(injectMutationStateFn, options?): Signal<TResult[]>
1512
```
1613

1714
Defined in: [inject-mutation-state.ts:60](https://github.com/TanStack/query/blob/main/packages/angular-query-experimental/src/inject-mutation-state.ts#L60)

‎docs/framework/angular/reference/functions/injectqueries.md‎

Lines changed: 0 additions & 43 deletions
This file was deleted.

‎docs/framework/angular/reference/functions/injectquery.md‎

Lines changed: 6 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,6 @@ title: injectQuery
1010
Injects a query: a declarative dependency on an asynchronous source of data that is tied to a unique key.
1111

1212
**Basic example**
13-
1413
```ts
1514
class ServiceOrComponent {
1615
query = injectQuery(() => ({
@@ -26,7 +25,6 @@ In the example below, the query will be automatically enabled and executed when
2625
to a truthy value. When the filter signal changes back to a falsy value, the query will be disabled.
2726

2827
**Reactive example**
29-
3028
```ts
3129
class ServiceOrComponent {
3230
filter = signal('')
@@ -55,18 +53,14 @@ https://tanstack.com/query/latest/docs/framework/angular/guides/queries
5553
## Call Signature
5654

5755
```ts
58-
function injectQuery<TQueryFnData, TError, TData, TQueryKey>(
59-
injectQueryFn,
60-
options?,
61-
): DefinedCreateQueryResult<TData, TError>
56+
function injectQuery<TQueryFnData, TError, TData, TQueryKey>(injectQueryFn, options?): DefinedCreateQueryResult<TData, TError>
6257
```
6358

6459
Defined in: [inject-query.ts:65](https://github.com/TanStack/query/blob/main/packages/angular-query-experimental/src/inject-query.ts#L65)
6560

6661
Injects a query: a declarative dependency on an asynchronous source of data that is tied to a unique key.
6762

6863
**Basic example**
69-
7064
```ts
7165
class ServiceOrComponent {
7266
query = injectQuery(() => ({
@@ -82,7 +76,6 @@ In the example below, the query will be automatically enabled and executed when
8276
to a truthy value. When the filter signal changes back to a falsy value, the query will be disabled.
8377

8478
**Reactive example**
85-
8679
```ts
8780
class ServiceOrComponent {
8881
filter = signal('')
@@ -104,7 +97,7 @@ class ServiceOrComponent {
10497
10598
• **TData** = `TQueryFnData`
10699
107-
• **TQueryKey** _extends_ readonly `unknown`[] = readonly `unknown`[]
100+
• **TQueryKey** *extends* readonly `unknown`[] = readonly `unknown`[]
108101
109102
### Parameters
110103
@@ -147,18 +140,14 @@ https://tanstack.com/query/latest/docs/framework/angular/guides/queries
147140
## Call Signature
148141
149142
```ts
150-
function injectQuery<TQueryFnData, TError, TData, TQueryKey>(
151-
injectQueryFn,
152-
options?,
153-
): CreateQueryResult<TData, TError>
143+
function injectQuery<TQueryFnData, TError, TData, TQueryKey>(injectQueryFn, options?): CreateQueryResult<TData, TError>
154144
```
155145

156146
Defined in: [inject-query.ts:116](https://github.com/TanStack/query/blob/main/packages/angular-query-experimental/src/inject-query.ts#L116)
157147

158148
Injects a query: a declarative dependency on an asynchronous source of data that is tied to a unique key.
159149

160150
**Basic example**
161-
162151
```ts
163152
class ServiceOrComponent {
164153
query = injectQuery(() => ({
@@ -174,7 +163,6 @@ In the example below, the query will be automatically enabled and executed when
174163
to a truthy value. When the filter signal changes back to a falsy value, the query will be disabled.
175164

176165
**Reactive example**
177-
178166
```ts
179167
class ServiceOrComponent {
180168
filter = signal('')
@@ -196,7 +184,7 @@ class ServiceOrComponent {
196184

197185
• **TData** = `TQueryFnData`
198186

199-
• **TQueryKey** _extends_ readonly `unknown`[] = readonly `unknown`[]
187+
• **TQueryKey** *extends* readonly `unknown`[] = readonly `unknown`[]
200188

201189
### Parameters
202190

@@ -239,18 +227,14 @@ https://tanstack.com/query/latest/docs/framework/angular/guides/queries
239227
## Call Signature
240228

241229
```ts
242-
function injectQuery<TQueryFnData, TError, TData, TQueryKey>(
243-
injectQueryFn,
244-
options?,
245-
): CreateQueryResult<TData, TError>
230+
function injectQuery<TQueryFnData, TError, TData, TQueryKey>(injectQueryFn, options?): CreateQueryResult<TData, TError>
246231
```
247232

248233
Defined in: [inject-query.ts:167](https://github.com/TanStack/query/blob/main/packages/angular-query-experimental/src/inject-query.ts#L167)
249234

250235
Injects a query: a declarative dependency on an asynchronous source of data that is tied to a unique key.
251236

252237
**Basic example**
253-
254238
```ts
255239
class ServiceOrComponent {
256240
query = injectQuery(() => ({
@@ -266,7 +250,6 @@ In the example below, the query will be automatically enabled and executed when
266250
to a truthy value. When the filter signal changes back to a falsy value, the query will be disabled.
267251

268252
**Reactive example**
269-
270253
```ts
271254
class ServiceOrComponent {
272255
filter = signal('')
@@ -288,7 +271,7 @@ class ServiceOrComponent {
288271

289272
• **TData** = `TQueryFnData`
290273

291-
• **TQueryKey** _extends_ readonly `unknown`[] = readonly `unknown`[]
274+
• **TQueryKey** *extends* readonly `unknown`[] = readonly `unknown`[]
292275

293276
### Parameters
294277

0 commit comments

Comments
 (0)