@tanstack/angular-query-experimental
v5.32.0
Published
Signals for managing, caching and syncing asynchronous and remote data in Angular
Downloads
14,247
Readme
Angular Query
This library is currently in an experimental stage. This means that breaking changes will happen in minor AND patch releases. Use at your own risk. If you choose to rely on this in production in an experimental stage, please lock your version to a patch-level version to avoid unexpected breakages.
Functions for fetching, caching and updating asynchronous data in Angular
Documentation
Visit https://tanstack.com/query/latest/docs/angular/overview
Quick Features
- Transport/protocol/backend agnostic data fetching (REST, GraphQL, promises, whatever!)
- Auto Caching + Refetching (stale-while-revalidate, Window Refocus, Polling/Realtime)
- Parallel + Dependent Queries
- Mutations + Reactive Query Refetching
- Multi-layer Cache + Automatic Garbage Collection
- Paginated + Cursor-based Queries
- Load-More + Infinite Scroll Queries w/ Scroll Recovery
- Request Cancellation
- Dedicated Devtools
Quick Start
Angular Query requires Angular 16.
Install
angular-query
$ npm i @tanstack/angular-query-experimental # or $ pnpm add @tanstack/angular-query-experimental # or $ yarn add @tanstack/angular-query-experimental # or $ bun add @tanstack/angular-query-experimental
Initialize Angular Query by adding provideAngularQuery to your application
import { provideAngularQuery } from '@tanstack/angular-query-experimental' import { QueryClient } from '@tanstack/angular-query-experimental' bootstrapApplication(AppComponent, { providers: [provideAngularQuery(new QueryClient())], })
Inject query
import { injectQuery } from '@tanstack/angular-query-experimental' import { Component } from '@angular/core' @Component({...}) export class TodosComponent { info = injectQuery(() => ({ queryKey: ['todos'], queryFn: fetchTodoList })) }
If you need to update options on your query dynamically, make sure to pass them as signals
import { injectQuery } from '@tanstack/angular-query-experimental' import { signal, Component } from '@angular/core' @Component({...}) export class TodosComponent { id = signal(1) enabled = signal(false) info = injectQuery(() => ({ queryKey: ['todos', this.id()], queryFn: fetchTodoList, enabled: this.enabled(), })) }