snapshot of https://github.com/TanStack/query.git (main, 2026-09-16; blobs > 131072B omitted)

examples/angular/infinite-query-with-max-pages/.devcontainer/devcontainer.json

@@ -0,0 +1,4 @@
+{
+  "name": "Node.js",
+  "image": "mcr.microsoft.com/devcontainers/javascript-node:22"
+}

examples/angular/infinite-query-with-max-pages/.eslintrc.cjs

@@ -0,0 +1,6 @@
+// @ts-check
+
+/** @type {import('eslint').Linter.Config} */
+const config = {}
+
+module.exports = config

examples/angular/infinite-query-with-max-pages/README.md

@@ -0,0 +1,6 @@
+# TanStack Query Angular infinite query example
+
+To run this example:
+
+- `pnpm install`
+- `pnpm start`

examples/angular/infinite-query-with-max-pages/angular.json

@@ -0,0 +1,130 @@
+{
+  "$schema": "./node_modules/@angular/cli/lib/config/schema.json",
+  "version": 1,
+  "cli": {
+    "packageManager": "pnpm",
+    "analytics": false,
+    "cache": {
+      "enabled": false
+    }
+  },
+  "newProjectRoot": "projects",
+  "projects": {
+    "infinite-query-with-max-pages": {
+      "projectType": "application",
+      "schematics": {
+        "@schematics/angular:component": {
+          "inlineTemplate": true,
+          "inlineStyle": true,
+          "skipTests": true
+        },
+        "@schematics/angular:class": {
+          "skipTests": true
+        },
+        "@schematics/angular:directive": {
+          "skipTests": true
+        },
+        "@schematics/angular:guard": {
+          "skipTests": true
+        },
+        "@schematics/angular:interceptor": {
+          "skipTests": true
+        },
+        "@schematics/angular:pipe": {
+          "skipTests": true
+        },
+        "@schematics/angular:resolver": {
+          "skipTests": true
+        },
+        "@schematics/angular:service": {
+          "skipTests": true
+        }
+      },
+      "root": "",
+      "sourceRoot": "src",
+      "prefix": "app",
+      "architect": {
+        "build": {
+          "builder": "@angular/build:application",
+          "options": {
+            "outputPath": "dist/infinite-query-with-max-pages",
+            "index": "src/index.html",
+            "browser": "src/main.ts",
+            "polyfills": ["zone.js"],
+            "tsConfig": "tsconfig.app.json",
+            "assets": ["src/favicon.ico", "src/mockServiceWorker.js"],
+            "styles": [],
+            "scripts": []
+          },
+          "configurations": {
+            "production": {
+              "budgets": [
+                {
+                  "type": "initial",
+                  "maximumWarning": "500kb",
+                  "maximumError": "1mb"
+                },
+                {
+                  "type": "anyComponentStyle",
+                  "maximumWarning": "2kb",
+                  "maximumError": "4kb"
+                }
+              ],
+              "outputHashing": "all"
+            },
+            "development": {
+              "optimization": false,
+              "extractLicenses": false,
+              "sourceMap": true
+            }
+          },
+          "defaultConfiguration": "production"
+        },
+        "serve": {
+          "builder": "@angular/build:dev-server",
+          "configurations": {
+            "production": {
+              "buildTarget": "infinite-query-with-max-pages:build:production"
+            },
+            "development": {
+              "buildTarget": "infinite-query-with-max-pages:build:development"
+            }
+          },
+          "defaultConfiguration": "development"
+        },
+        "extract-i18n": {
+          "builder": "@angular/build:extract-i18n",
+          "options": {
+            "buildTarget": "infinite-query-with-max-pages:build"
+          }
+        }
+      }
+    }
+  },
+  "schematics": {
+    "@schematics/angular:component": {
+      "type": "component"
+    },
+    "@schematics/angular:directive": {
+      "type": "directive"
+    },
+    "@schematics/angular:service": {
+      "type": "service"
+    },
+    "@schematics/angular:guard": {
+      "typeSeparator": "."
+    },
+    "@schematics/angular:interceptor": {
+      "typeSeparator": "."
+    },
+    "@schematics/angular:module": {
+      "typeSeparator": "."
+    },
+    "@schematics/angular:pipe": {
+      "typeSeparator": "."
+    },
+    "@schematics/angular:resolver": {
+      "typeSeparator": "."
+    }
+  }
+}

examples/angular/infinite-query-with-max-pages/package.json

@@ -0,0 +1,27 @@
+{
+  "name": "@tanstack/query-example-angular-infinite-query-with-max-pages",
+  "private": true,
+  "type": "module",
+  "scripts": {
+    "ng": "ng",
+    "start": "ng serve",
+    "build": "ng build",
+    "watch": "ng build --watch --configuration development"
+  },
+  "dependencies": {
+    "@angular/common": "^20.0.0",
+    "@angular/compiler": "^20.0.0",
+    "@angular/core": "^20.0.0",
+    "@angular/platform-browser": "^20.0.0",
+    "@tanstack/angular-query-experimental": "^5.102.8",
+    "rxjs": "^7.8.2",
+    "tslib": "^2.8.1",
+    "zone.js": "0.15.0"
+  },
+  "devDependencies": {
+    "@angular/build": "^20.0.0",
+    "@angular/cli": "^20.0.0",
+    "@angular/compiler-cli": "^20.0.0",
+    "typescript": "5.8.3"
+  }
+}

examples/angular/infinite-query-with-max-pages/src/app/api/projects-mock.interceptor.ts

@@ -0,0 +1,45 @@
+import { HttpResponse } from '@angular/common/http'
+import { delayWhen, of, timer } from 'rxjs'
+import type { Observable } from 'rxjs'
+import type { HttpEvent, HttpInterceptorFn } from '@angular/common/http'
+
+export const projectsMockInterceptor: HttpInterceptorFn = (
+  req,
+  next,
+): Observable<HttpEvent<any>> => {
+  const { url } = req
+
+  if (url.includes('/api/projects')) {
+    const cursor = parseInt(
+      new URLSearchParams(req.url.split('?')[1]).get('cursor') || '0',
+      10,
+    )
+    const pageSize = 4
+
+    const data = Array(pageSize)
+      .fill(0)
+      .map((_, i) => {
+        return {
+          name: 'Project ' + (i + cursor) + ` (server time: ${Date.now()})`,
+          id: i + cursor,
+        }
+      })
+
+    const nextId = cursor < 20 ? data[data.length - 1].id + 1 : null
+    const previousId = cursor > -20 ? data[0].id - pageSize : null
+
+    // Simulate network latency with a random delay between 100ms and 500ms
+    const delayDuration = Math.random() * (500 - 100) + 100
+    return of(
+      new HttpResponse({
+        status: 200,
+        body: {
+          data,
+          nextId,
+          previousId,
+        },
+      }),
+    ).pipe(delayWhen(() => timer(delayDuration)))
+  }
+  return next(req)
+}

examples/angular/infinite-query-with-max-pages/src/app/app.component.ts

@@ -0,0 +1,10 @@
+import { ChangeDetectionStrategy, Component } from '@angular/core'
+import { ExampleComponent } from './components/example.component'
+
+@Component({
+  changeDetection: ChangeDetectionStrategy.OnPush,
+  selector: 'app-root',
+  template: `<example />`,
+  imports: [ExampleComponent],
+})
+export class AppComponent {}

examples/angular/infinite-query-with-max-pages/src/app/app.config.ts

@@ -0,0 +1,28 @@
+import {
+  provideHttpClient,
+  withFetch,
+  withInterceptors,
+} from '@angular/common/http'
+import {
+  QueryClient,
+  provideTanStackQuery,
+} from '@tanstack/angular-query-experimental'
+import { withDevtools } from '@tanstack/angular-query-experimental/devtools'
+import { projectsMockInterceptor } from './api/projects-mock.interceptor'
+import type { ApplicationConfig } from '@angular/core'
+
+export const appConfig: ApplicationConfig = {
+  providers: [
+    provideHttpClient(withInterceptors([projectsMockInterceptor]), withFetch()),
+    provideTanStackQuery(
+      new QueryClient({
+        defaultOptions: {
+          queries: {
+            gcTime: 1000 * 60 * 60 * 24, // 24 hours
+          },
+        },
+      }),
+      withDevtools(),
+    ),
+  ],
+}

examples/angular/infinite-query-with-max-pages/src/app/components/example.component.html

@@ -0,0 +1,37 @@
+<div>
+  <h1>Infinite Query with max pages</h1>
+  <h3>4 projects per page</h3>
+  <h3>3 pages max</h3>
+  @if (query.isPending()) {
+    <p>Loading...</p>
+  } @else if (query.isError()) {
+    <span>Error: {{ query.error().message }}</span>
+  } @else {
+    <div>
+      <button
+        (click)="query.fetchPreviousPage()"
+        [disabled]="previousButtonDisabled()"
+      >
+        {{ previousButtonText() }}
+      </button>
+    </div>
+    @for (page of query.data().pages; track $index) {
+      @for (project of page.data; track project.id) {
+        <p [projectStyle]="project.id">{{ project.name }} {{ project.id }}</p>
+      }
+    }
+    <div>
+      <button (click)="query.fetchNextPage()" [disabled]="nextButtonDisabled()">
+        {{ nextButtonText() }}
+      </button>
+    </div>
+    <div>
+      {{
+        query.isFetching() && !query.isFetchingNextPage()
+          ? 'Background Updating...'
+          : null
+      }}
+    </div>
+  }
+  <hr />
+</div>

examples/angular/infinite-query-with-max-pages/src/app/components/example.component.ts

@@ -0,0 +1,59 @@
+import {
+  ChangeDetectionStrategy,
+  Component,
+  computed,
+  inject,
+} from '@angular/core'
+import { injectInfiniteQuery } from '@tanstack/angular-query-experimental'
+import { lastValueFrom } from 'rxjs'
+import { ProjectStyleDirective } from '../directives/project-style.directive'
+import { ProjectsService } from '../services/projects.service'
+
+@Component({
+  changeDetection: ChangeDetectionStrategy.OnPush,
+  selector: 'example',
+  templateUrl: './example.component.html',
+  imports: [ProjectStyleDirective],
+})
+export class ExampleComponent {
+  readonly projectsService = inject(ProjectsService)
+
+  readonly query = injectInfiniteQuery(() => ({
+    queryKey: ['projects'],
+    queryFn: ({ pageParam }) => {
+      return lastValueFrom(this.projectsService.getProjects(pageParam))
+    },
+    initialPageParam: 0,
+    getPreviousPageParam: (firstPage) => firstPage.previousId ?? undefined,
+    getNextPageParam: (lastPage) => lastPage.nextId ?? undefined,
+    maxPages: 3,
+  }))
+
+  readonly nextButtonDisabled = computed(
+    () => !this.#hasNextPage() || this.#isFetchingNextPage(),
+  )
+
+  readonly nextButtonText = computed(() =>
+    this.#isFetchingNextPage()
+      ? 'Loading more...'
+      : this.#hasNextPage()
+        ? 'Load newer'
+        : 'Nothing more to load',
+  )
+
+  readonly previousButtonDisabled = computed(
+    () => !this.#hasPreviousPage() || this.#isFetchingNextPage(),
+  )
+  readonly previousButtonText = computed(() =>
+    this.#isFetchingPreviousPage()
+      ? 'Loading more...'
+      : this.#hasPreviousPage()
+        ? 'Load Older'
+        : 'Nothing more to load',
+  )
+
+  readonly #hasPreviousPage = this.query.hasPreviousPage
+  readonly #hasNextPage = this.query.hasNextPage
+  readonly #isFetchingPreviousPage = this.query.isFetchingPreviousPage
+  readonly #isFetchingNextPage = this.query.isFetchingNextPage
+}

examples/angular/infinite-query-with-max-pages/src/app/directives/project-style.directive.ts

@@ -0,0 +1,22 @@
+import { Directive, computed, input } from '@angular/core'
+
+@Directive({
+  selector: '[projectStyle]',
+  host: {
+    '[style]': 'style()',
+  },
+})
+export class ProjectStyleDirective {
+  readonly projectStyle = input.required<number>()
+
+  readonly style = computed(
+    () =>
+      `
+      border: 1px solid gray;
+      border-radius: 5px;
+      padding: 8px;
+      font-size: 14px;
+      background: hsla(${this.projectStyle() * 30}, 60%, 80%, 1);
+    `,
+  )
+}

examples/angular/infinite-query-with-max-pages/src/app/services/projects.service.ts

@@ -0,0 +1,22 @@
+import { HttpClient } from '@angular/common/http'
+import { Injectable, inject } from '@angular/core'
+
+interface Project {
+  id: number
+  name: string
+}
+
+interface ProjectResponse {
+  data: Array<Project>
+  nextId: number | undefined
+  previousId: number | undefined
+}
+
+@Injectable({
+  providedIn: 'root',
+})
+export class ProjectsService {
+  readonly #http = inject(HttpClient)
+  getProjects = (page: number) =>
+    this.#http.get<ProjectResponse>(`/api/projects?cursor=${page}`)
+}

examples/angular/infinite-query-with-max-pages/src/index.html

@@ -0,0 +1,13 @@
+<!doctype html>
+<html lang="en">
+  <head>
+    <meta charset="utf-8" />
+    <title>TanStack Query Angular infinite query example</title>
+    <base href="/" />
+    <meta name="viewport" content="width=device-width, initial-scale=1" />
+    <link rel="icon" type="image/x-icon" href="favicon.ico" />
+  </head>
+  <body>
+    <app-root></app-root>
+  </body>
+</html>

examples/angular/infinite-query-with-max-pages/src/main.ts

@@ -0,0 +1,5 @@
+import { bootstrapApplication } from '@angular/platform-browser'
+import { appConfig } from './app/app.config'
+import { AppComponent } from './app/app.component'
+
+bootstrapApplication(AppComponent, appConfig).catch((err) => console.error(err))

examples/angular/infinite-query-with-max-pages/tsconfig.app.json

@@ -0,0 +1,9 @@
+{
+  "extends": "./tsconfig.json",
+  "compilerOptions": {
+    "outDir": "./out-tsc/app",
+    "types": []
+  },
+  "files": ["src/main.ts"],
+  "include": ["src/**/*.d.ts"]
+}

examples/angular/infinite-query-with-max-pages/tsconfig.json

@@ -0,0 +1,31 @@
+{
+  "compileOnSave": false,
+  "compilerOptions": {
+    "outDir": "./dist/out-tsc",
+    "forceConsistentCasingInFileNames": true,
+    "strict": true,
+    "noImplicitOverride": true,
+    "noPropertyAccessFromIndexSignature": true,
+    "noImplicitReturns": true,
+    "noFallthroughCasesInSwitch": true,
+    "skipLibCheck": true,
+    "isolatedModules": true,
+    "esModuleInterop": true,
+    "sourceMap": true,
+    "declaration": false,
+    "experimentalDecorators": true,
+    "moduleResolution": "Bundler",
+    "importHelpers": true,
+    "target": "ES2022",
+    "module": "ES2022",
+    "useDefineForClassFields": false,
+    "lib": ["ES2022", "dom"]
+  },
+  "angularCompilerOptions": {
+    "enableI18nLegacyMessageIdFormat": false,
+    "strictInjectionParameters": true,
+    "strictInputAccessModifiers": true,
+    "strictStandalone": true,
+    "strictTemplates": true
+  }
+}