Skip to content

Commit a690c53

Browse files
authored
fix(docs): say why signal history is sampled before Angular 20 (#462)
Installation no longer claims signal history uses samples under webpack on Angular 17 to 19. Value history is part of the live graph, which needs Angular 20.1, and the Signals page says so.
1 parent dd7d689 commit a690c53

2 files changed

Lines changed: 9 additions & 9 deletions

File tree

‎apps/docs/src/content/getting-started/installation.md‎

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -64,14 +64,14 @@ On Angular 12 to 19 the overlay degrades as the table above shows:
6464

6565
### Setup on Angular 12 to 19
6666

67-
| Setup | Angular 12 to 16 | Angular 17 to 19 |
68-
| ---------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------- |
69-
| Overlay import in `main.ts` | Works with the webpack-based `@angular-devkit/build-angular:browser` builder. Signal history uses samples, since `@angular/core/primitives/signals` exists from 17.0. | Works with `browser` and `application`. Under webpack, signal history uses samples. |
70-
| Vite plugin (Analog) | Works. The plugin points `@angular/core/primitives/signals` at a stub before 17.0. | Works. |
71-
| `initPangularHub()` in an Express server | Works when the server runs on Node.js 22.12 or later. On an older Node.js the hub logs why and turns itself off. To keep the devtools there, run the standalone CLI on Node.js 22.12 or later beside it instead. | Works. |
72-
| Standalone CLI next to `ng serve` | Works. Run `npx pangular dev` with Node.js 22.12 or later, and the app's own CLI with the Node.js version it supports. | Works. |
73-
| Chrome extension | Works on top of any of the setups above. | Works. |
74-
| `@pangular-inspector/devtools/http` | Not available. It imports `REQUEST` and `provideEnvironmentInitializer`, so the build fails. Leave it out; the HTTP timeline and fault rules need it. | Not available before 19.0, for the same reason. |
67+
| Setup | Angular 12 to 16 | Angular 17 to 19 |
68+
| ---------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------- |
69+
| Overlay import in `main.ts` | Works with the webpack-based `@angular-devkit/build-angular:browser` builder. | Works with `browser` and `application`. |
70+
| Vite plugin (Analog) | Works. The plugin points `@angular/core/primitives/signals` at a stub before 17.0. | Works. |
71+
| `initPangularHub()` in an Express server | Works when the server runs on Node.js 22.12 or later. On an older Node.js the hub logs why and turns itself off. To keep the devtools there, run the standalone CLI on Node.js 22.12 or later beside it instead. | Works. |
72+
| Standalone CLI next to `ng serve` | Works. Run `npx pangular dev` with Node.js 22.12 or later, and the app's own CLI with the Node.js version it supports. | Works. |
73+
| Chrome extension | Works on top of any of the setups above. | Works. |
74+
| `@pangular-inspector/devtools/http` | Not available. It imports `REQUEST` and `provideEnvironmentInitializer`, so the build fails. Leave it out; the HTTP timeline and fault rules need it. | Not available before 19.0, for the same reason. |
7575

7676
With the webpack-based `browser` builder, use the standalone CLI next to `ng serve`, as in [Client-only Angular CLI app](#client-only-angular-cli-app), or the Express hub for an SSR app.
7777

‎apps/docs/src/content/inspectors/signals.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -162,7 +162,7 @@ Angular doesn't send a value for `linkedSignal` nodes. The overlay takes it from
162162

163163
### Exact and sampled values
164164

165-
Exact **set** entries come from a hook on signal writes, which the overlay loads from `@angular/core/primitives/signals`. A webpack build (the `browser` builder) leaves that import to run time, where it fails, so there every entry is **sampled**. The overlay matches a write to a node by its name, kind, version and value. It samples everything else each time it reads the page, as **sampled** entries.
165+
The value history is part of the live graph, so it needs Angular 20.1 or later. Exact **set** entries come from a hook on signal writes, which the overlay loads from `@angular/core/primitives/signals`. A webpack build (the `browser` builder) leaves that import to run time, where it fails, so there every entry is **sampled**. The overlay matches a write to a node by its name, kind, version and value. It samples everything else each time it reads the page, as **sampled** entries.
166166

167167
In a development build, the Angular compiler names most signals for you. It adds a `debugName` to `signal()`, `computed()`, `linkedSignal()`, `input()`, `model()`, queries, `effect()`, `resource()` and `httpResource()` when the call initializes a class field, a `this.name =` assignment or a variable. The name is the field or variable name.
168168

0 commit comments

Comments
 (0)