Skip to content

Commit 7eaeaf9

Browse files
arnoud-dvarnoud-dv
committed
update documentation
1 parent f00280a commit 7eaeaf9

17 files changed

+39
-45
lines changed

‎docs/framework/angular/devtools.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ import {
1414
QueryClient,
1515
provideTanStackQuery,
1616
withDevtools,
17-
} from '@tanstack/angular-query-experimental'
17+
} from '@tanstack/angular-query'
1818

1919
export const appConfig: ApplicationConfig = {
2020
providers: [provideTanStackQuery(new QueryClient(), withDevtools())],

‎docs/framework/angular/guides/background-fetching-indicators.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@ export class TodosComponent {
4040
[//]: # 'Example2'
4141

4242
```angular-ts
43-
import { injectIsFetching } from '@tanstack/angular-query-experimental'
43+
import { injectIsFetching } from '@tanstack/angular-query'
4444
4545
@Component({
4646
selector: 'global-loading-indicator',

‎docs/framework/angular/guides/infinite-queries.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ replace:
1010

1111
```angular-ts
1212
import { Component, computed, inject } from '@angular/core'
13-
import { injectInfiniteQuery } from '@tanstack/angular-query-experimental'
13+
import { injectInfiniteQuery } from '@tanstack/angular-query'
1414
import { lastValueFrom } from 'rxjs'
1515
import { ProjectsService } from './projects-service'
1616

‎docs/framework/angular/guides/invalidations-from-mutations.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ mutation = injectMutation(() => ({
2020
import {
2121
injectMutation,
2222
QueryClient,
23-
} from '@tanstack/angular-query-experimental'
23+
} from '@tanstack/angular-query'
2424

2525
export class TodosComponent {
2626
queryClient = inject(QueryClient)

‎docs/framework/angular/guides/queries.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ replace:
1616
[//]: # 'Example'
1717

1818
```ts
19-
import { injectQuery } from '@tanstack/angular-query-experimental'
19+
import { injectQuery } from '@tanstack/angular-query'
2020

2121
export class TodosComponent {
2222
info = injectQuery(() => ({ queryKey: ['todos'], queryFn: fetchTodoList }))

‎docs/framework/angular/guides/query-cancellation.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ However, if you consume the `AbortSignal`, the Promise will be cancelled (e.g. a
1515

1616
```ts
1717
import { HttpClient } from '@angular/common/http'
18-
import { injectQuery } from '@tanstack/angular-query-experimental'
18+
import { injectQuery } from '@tanstack/angular-query'
1919

2020
postQuery = injectQuery(() => ({
2121
enabled: this.postId() > 0,

‎docs/framework/angular/guides/query-invalidation.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ replace: { 'useQuery': 'injectQuery', 'hooks': 'functions' }
88
[//]: # 'Example2'
99

1010
```ts
11-
import { injectQuery, QueryClient } from '@tanstack/angular-query-experimental'
11+
import { injectQuery, QueryClient } from '@tanstack/angular-query'
1212

1313
class QueryInvalidationExample {
1414
queryClient = inject(QueryClient)

‎docs/framework/angular/guides/query-options.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ ref: docs/framework/react/guides/query-options.md
77
[//]: # 'Example1'
88

99
```ts
10-
import { queryOptions } from '@tanstack/angular-query-experimental'
10+
import { queryOptions } from '@tanstack/angular-query'
1111

1212
@Injectable({
1313
providedIn: 'root',

‎docs/framework/angular/guides/query-retries.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ replace:
1515
[//]: # 'Example'
1616

1717
```ts
18-
import { injectQuery } from '@tanstack/angular-query-experimental'
18+
import { injectQuery } from '@tanstack/angular-query'
1919

2020
// Make a specific query retry a certain number of times
2121
const result = injectQuery(() => ({
@@ -34,7 +34,7 @@ import {
3434
QueryCache,
3535
QueryClient,
3636
QueryClientProvider,
37-
} from '@tanstack/angular-query-experimental'
37+
} from '@tanstack/angular-query'
3838

3939
const queryClient = new QueryClient({
4040
defaultOptions: {

‎docs/framework/angular/guides/window-focus-refetching.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
id: window-focus-refetching
33
title: Window Focus Refetching
44
ref: docs/framework/react/guides/window-focus-refetching.md
5-
replace: { '@tanstack/react-query': '@tanstack/angular-query-experimental' }
5+
replace: { '@tanstack/react-query': '@tanstack/angular-query' }
66
---
77

88
[//]: # 'Example'

‎docs/framework/angular/installation.md

Lines changed: 4 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -3,32 +3,30 @@ id: installation
33
title: Installation
44
---
55

6-
> IMPORTANT: This library is currently in an experimental stage. This means that breaking changes will happen in minor AND patch releases. Upgrade carefully. If you use this in production while in experimental stage, please lock your version to a patch-level version to avoid unexpected breaking changes.
7-
86
### NPM
97

108
_Angular Query is compatible with Angular v16 and higher_
119

1210
```bash
13-
npm i @tanstack/angular-query-experimental
11+
npm i @tanstack/angular-query
1412
```
1513

1614
or
1715

1816
```bash
19-
pnpm add @tanstack/angular-query-experimental
17+
pnpm add @tanstack/angular-query
2018
```
2119

2220
or
2321

2422
```bash
25-
yarn add @tanstack/angular-query-experimental
23+
yarn add @tanstack/angular-query
2624
```
2725

2826
or
2927

3028
```bash
31-
bun add @tanstack/angular-query-experimental
29+
bun add @tanstack/angular-query
3230
```
3331

3432
> Wanna give it a spin before you download? Try out the [simple](../examples/simple) or [basic](../examples/basic) examples!

‎docs/framework/angular/overview.md

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -3,9 +3,7 @@ id: overview
33
title: Overview
44
---
55

6-
> IMPORTANT: This library is currently in an experimental stage. This means that breaking changes will happen in minor AND patch releases. Upgrade carefully. If you use this in production while in experimental stage, please lock your version to a patch-level version to avoid unexpected breaking changes.
7-
8-
The `@tanstack/angular-query-experimental` package offers a 1st-class API for using TanStack Query via Angular.
6+
The `@tanstack/angular-query` package offers a 1st-class API for using TanStack Query via Angular.
97

108
## Feedback welcome!
119

@@ -64,7 +62,7 @@ In the example below, you can see TanStack Query in its most basic and simple fo
6462
import { ChangeDetectionStrategy, Component, inject } from '@angular/core'
6563
import { HttpClient } from '@angular/common/http'
6664
import { CommonModule } from '@angular/common'
67-
import { injectQuery } from '@tanstack/angular-query-experimental'
65+
import { injectQuery } from '@tanstack/angular-query'
6866
import { lastValueFrom } from 'rxjs'
6967
7068
@Component({

‎docs/framework/angular/quick-start.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ import { provideHttpClient } from '@angular/common/http'
1616
import {
1717
provideTanStackQuery,
1818
QueryClient,
19-
} from '@tanstack/angular-query-experimental'
19+
} from '@tanstack/angular-query'
2020

2121
bootstrapApplication(AppComponent, {
2222
providers: [provideHttpClient(), provideTanStackQuery(new QueryClient())],
@@ -30,7 +30,7 @@ import { provideHttpClient } from '@angular/common/http'
3030
import {
3131
provideTanStackQuery,
3232
QueryClient,
33-
} from '@tanstack/angular-query-experimental'
33+
} from '@tanstack/angular-query'
3434

3535
@NgModule({
3636
declarations: [AppComponent],
@@ -52,7 +52,7 @@ import {
5252
injectMutation,
5353
injectQuery,
5454
QueryClient
55-
} from '@tanstack/angular-query-experimental'
55+
} from '@tanstack/angular-query'
5656
5757
@Component({
5858
standalone: true,

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ Allows to configure a `QueryClient`.
1919
import {
2020
provideAngularQuery,
2121
QueryClient,
22-
} from '@tanstack/angular-query-experimental'
22+
} from '@tanstack/angular-query'
2323
2424
bootstrapApplication(AppComponent, {
2525
providers: [provideAngularQuery(new QueryClient())],
@@ -32,7 +32,7 @@ bootstrapApplication(AppComponent, {
3232
import {
3333
provideAngularQuery,
3434
QueryClient,
35-
} from '@tanstack/angular-query-experimental'
35+
} from '@tanstack/angular-query'
3636
3737
@NgModule({
3838
declarations: [AppComponent],

‎docs/framework/angular/typescript.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -149,9 +149,9 @@ computed(() => {
149149
[//]: # 'RegisterErrorType'
150150

151151
```ts
152-
import '@tanstack/angular-query-experimental'
152+
import '@tanstack/angular-query'
153153

154-
declare module '@tanstack/angular-query-experimental' {
154+
declare module '@tanstack/angular-query' {
155155
interface Register {
156156
defaultError: AxiosError
157157
}

‎packages/angular-query/README.md

Lines changed: 12 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,12 @@
11
![TanStack Query Header](https://github.com/TanStack/query/raw/main/media/repo-header.png)
22

3-
[![npm version](https://img.shields.io/npm/v/@tanstack/angular-query-experimental)](https://www.npmjs.com/package/@tanstack/angular-query-experimental)
4-
[![npm license](https://img.shields.io/npm/l/@tanstack/angular-query-experimental)](https://github.com/TanStack/query/blob/main/LICENSE)
5-
[![bundle size](https://img.shields.io/bundlephobia/minzip/@tanstack/angular-query-experimental)](https://bundlephobia.com/package/@tanstack/angular-query-experimental)
6-
[![npm](https://img.shields.io/npm/dm/@tanstack/angular-query-experimental)](https://www.npmjs.com/package/@tanstack/angular-query-experimental)
3+
[![npm version](https://img.shields.io/npm/v/@tanstack/angular-query)](https://www.npmjs.com/package/@tanstack/angular-query)
4+
[![npm license](https://img.shields.io/npm/l/@tanstack/angular-query)](https://github.com/TanStack/query/blob/main/LICENSE)
5+
[![bundle size](https://img.shields.io/bundlephobia/minzip/@tanstack/angular-query)](https://bundlephobia.com/package/@tanstack/angular-query)
6+
[![npm](https://img.shields.io/npm/dm/@tanstack/angular-query)](https://www.npmjs.com/package/@tanstack/angular-query)
77

88
# Angular Query
99

10-
> IMPORTANT: This library is currently in an experimental stage. This means that breaking changes may happen in minor AND patch releases. Upgrade carefully. If you use this in production while in experimental stage, please lock your version to a patch-level version to avoid unexpected breaking changes.
11-
1210
Functions for fetching, caching and updating asynchronous data in Angular
1311

1412
# Documentation
@@ -34,32 +32,32 @@ Visit https://tanstack.com/query/latest/docs/framework/angular/overview
3432
1. Install `angular-query`
3533

3634
```bash
37-
$ npm i @tanstack/angular-query-experimental
35+
$ npm i @tanstack/angular-query
3836
```
3937

4038
or
4139

4240
```bash
43-
$ pnpm add @tanstack/angular-query-experimental
41+
$ pnpm add @tanstack/angular-query
4442
```
4543

4644
or
4745

4846
```bash
49-
$ yarn add @tanstack/angular-query-experimental
47+
$ yarn add @tanstack/angular-query
5048
```
5149

5250
or
5351

5452
```bash
55-
$ bun add @tanstack/angular-query-experimental
53+
$ bun add @tanstack/angular-query
5654
```
5755

5856
2. Initialize **TanStack Query** by adding **provideTanStackQuery** to your application
5957

6058
```ts
61-
import { provideTanStackQuery } from '@tanstack/angular-query-experimental'
62-
import { QueryClient } from '@tanstack/angular-query-experimental'
59+
import { provideTanStackQuery } from '@tanstack/angular-query'
60+
import { QueryClient } from '@tanstack/angular-query'
6361

6462
bootstrapApplication(AppComponent, {
6563
providers: [provideTanStackQuery(new QueryClient())],
@@ -73,7 +71,7 @@ import { provideHttpClient } from '@angular/common/http'
7371
import {
7472
provideTanStackQuery,
7573
QueryClient,
76-
} from '@tanstack/angular-query-experimental'
74+
} from '@tanstack/angular-query'
7775

7876
@NgModule({
7977
declarations: [AppComponent],
@@ -86,7 +84,7 @@ import {
8684
3. Inject query
8785

8886
```ts
89-
import { injectQuery } from '@tanstack/angular-query-experimental'
87+
import { injectQuery } from '@tanstack/angular-query'
9088
import { Component } from '@angular/core'
9189

9290
@Component({...})

‎packages/angular-query/src/providers.ts

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@ export function provideQueryClient(queryClient: QueryClient) {
4444
* import {
4545
* provideTanStackQuery,
4646
* QueryClient,
47-
* } from '@tanstack/angular-query-experimental'
47+
* } from '@tanstack/angular-query'
4848
*
4949
* bootstrapApplication(AppComponent, {
5050
* providers: [provideTanStackQuery(new QueryClient())],
@@ -57,7 +57,7 @@ export function provideQueryClient(queryClient: QueryClient) {
5757
* import {
5858
* provideTanStackQuery,
5959
* QueryClient,
60-
* } from '@tanstack/angular-query-experimental'
60+
* } from '@tanstack/angular-query'
6161
*
6262
* @NgModule({
6363
* declarations: [AppComponent],
@@ -75,7 +75,7 @@ export function provideQueryClient(queryClient: QueryClient) {
7575
* provideTanStackQuery,
7676
* withDevtools
7777
* QueryClient,
78-
* } from '@tanstack/angular-query-experimental'
78+
* } from '@tanstack/angular-query'
7979
*
8080
* bootstrapApplication(AppComponent,
8181
* {

0 commit comments

Comments
 (0)