Skip to content
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.

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

docs(angular-query): document httpclient and other data fetching solutions #8732

Merged
merged 1 commit into from
Mar 1, 2025
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
4 changes: 4 additions & 0 deletions docs/config.json
Original file line number Diff line number Diff line change
Expand Up @@ -141,6 +141,10 @@
"label": "Quick Start",
"to": "framework/angular/quick-start"
},
{
"label": "Angular HttpClient and other data fetching clients",
"to": "framework/angular/angular-httpclient-and-other-data-fetching-clients"
},
{
"label": "Devtools",
"to": "framework/angular/devtools"
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,48 @@
---
id: Angular-HttpClient-and-other-data-fetching-clients
title: Angular HttpClient and other data fetching clients
---

Because TanStack Query's fetching mechanisms are agnostically built on Promises, you can use literally any asynchronous data fetching client, including the browser native `fetch` API, `graphql-request`, and more.

## Using Angular's `HttpClient` for data fetching

`HttpClient` is a powerful and integrated part of Angular, which gives the following benefits:

- Mock responses in unit tests using [provideHttpClientTesting](https://angular.dev/guide/http/testing).
- [Interceptors](https://angular.dev/guide/http/interceptors) can be used for a wide range of functionality including adding authentication headers, performing logging, etc. While some data fetching libraries have their own interceptor system, `HttpClient` interceptors are integrated with Angular's dependency injection system.
- `HttpClient` automatically informs [`PendingTasks`](https://angular.dev/api/core/PendingTasks#), which enables Angular to be aware of pending requests. Unit tests and SSR can use the resulting application _stableness_ information to wait for pending requests to finish. This makes unit testing much easier for [Zoneless](https://angular.dev/guide/experimental/zoneless) applications.
- When using SSR, `HttpClient` will [cache requests](https://angular.dev/guide/ssr#caching-data-when-using-HttpClient) performed on the server. This will prevent unneeded requests on the client. `HttpClient` SSR caching works out of the box. TanStack Query has its own hydration functionality which may be more powerful but requires some setup. Which one fits your needs best depends on your use case.

### Using observables in `queryFn`

As TanStack Query is a promise based library, observables from `HttpClient` need to be converted to promises. This can be done with the `lastValueFrom` or `firstValueFrom` functions from `rxjs`.

```ts
@Component({
// ...
})
class ExampleComponent {
private readonly http = inject(HttpClient)

readonly query = injectQuery(() => ({
queryKey: ['repoData'],
queryFn: () =>
lastValueFrom(
this.http.get('https://api.github.com/repos/tanstack/query'),
),
}))
}
```

> Since Angular is moving towards RxJS as an optional dependency, it's expected that `HttpClient` will also support promises in the future.
>
> Support for observables in TanStack Query for Angular is planned.

## Comparison table

| Data fetching client | Pros | Cons |
| --------------------------------------------------- | --------------------------------------------------- | -------------------------------------------------------------------------- |
| **Angular HttpClient** | Featureful and very well integrated with Angular. | Observables need to be converted to Promises. |
| **Fetch** | Browser native API, so adds nothing to bundle size. | Barebones API which lacks many features. |
| **Specialized libraries such as `graphql-request`** | Specialized features for specific use cases. | If it's not an Angular library it won't integrate well with the framework. |
26 changes: 11 additions & 15 deletions docs/framework/angular/guides/background-fetching-indicators.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,27 +8,23 @@ ref: docs/framework/react/guides/background-fetching-indicators.md

```angular-ts
@Component({
selector: 'posts',
selector: 'todos',
template: `
@switch (query.status()) {
@case ('pending') {
Loading...
@if (todosQuery.isPending()) {
Loading...
} @else if (todosQuery.isError()) {
An error has occurred: {{ todosQuery.error().message }}
} @else if (todosQuery.isSuccess()) {
@if (todosQuery.isFetching()) {
Refreshing...
}
@case ('error') {
An error has occurred: {{ query.error()?.message }}
}
@default {
@if (query.isFetching()) {
Refreshing...
}
@for (todo of query.data()) {
<todo [todo]="todo" />
}
@for (todos of todosQuery.data(); track todo.id) {
<todo [todo]="todo" />
}
}
`,
})
export class TodosComponent {
class TodosComponent {
todosQuery = injectQuery(() => ({
queryKey: ['todos'],
queryFn: fetchTodos,
Expand Down
2 changes: 2 additions & 0 deletions docs/framework/angular/guides/disabling-queries.md
Original file line number Diff line number Diff line change
Expand Up @@ -70,6 +70,8 @@ export class TodosComponent {
[//]: # 'Example3'

```angular-ts
import { skipToken, injectQuery } from '@tanstack/query-angular'

@Component({
selector: 'todos',
template: `
Expand Down
1 change: 1 addition & 0 deletions docs/framework/angular/guides/queries.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@ replace:
'custom hooks': 'services',
'the `useQuery` hook': '`injectQuery`',
'`useQuery`': '`injectQuery`',
"TypeScript will also narrow the type of data correctly if you've checked for pending and error before accessing it.": 'TypeScript will only narrow the type when checking boolean signals such as `isPending` and `isError`.',
}
---

Expand Down
4 changes: 2 additions & 2 deletions docs/framework/angular/guides/window-focus-refetching.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ replace: { '@tanstack/react-query': '@tanstack/angular-query-experimental' }
[//]: # 'Example'

```ts
bootstrapApplication(AppComponent, {
export const appConfig: ApplicationConfig = {
providers: [
provideTanStackQuery(
new QueryClient({
Expand All @@ -20,7 +20,7 @@ bootstrapApplication(AppComponent, {
}),
),
],
})
}
```

[//]: # 'Example'
Expand Down
Empty file.
Empty file.
Empty file.
Loading