docs(angular): use signal input in placeholder-query-data.md#9641
docs(angular): use signal input in placeholder-query-data.md#9641arnoud-dv merged 1 commit intoTanStack:mainfrom
Conversation
WalkthroughUpdates a documentation code sample in an Angular guide, replacing a signal-based @input pattern with the new input.required() API and removing the previous setter and initialization. Associated comments about signal-based inputs are removed. No other files or logic are changed. Changes
Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 minutes Pre-merge checks (3 passed)✅ Passed checks (3 passed)
Poem
Tip 👮 Agentic pre-merge checks are now available in preview!Pro plan users can now enable pre-merge checks in their settings to enforce checklists before merging PRs.
Please see the documentation for more information. Example: reviews:
pre_merge_checks:
custom_checks:
- name: "Undocumented Breaking Changes"
mode: "warning"
instructions: |
Pass/fail criteria: All breaking changes to public APIs, CLI flags, environment variables, configuration keys, database schemas, or HTTP/GraphQL endpoints must be documented in the "Breaking Change" section of the PR description and in CHANGELOG.md. Exclude purely internal or private changes (e.g., code not exported from package entry points or explicitly marked as internal).Please share your feedback with us on this Discord post. ✨ Finishing touches🧪 Generate unit tests
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
github-actions
Bot
added
the
documentation
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
Caution
Some comments are outside the diff and can’t be posted inline due to platform limitations.
⚠️ Outside diff range comments (1)
docs/framework/angular/guides/placeholder-query-data.md (1)
48-51: Fix: reference the injected client viathis.
queryClientis a class field; using it unqualified will not compile in TS. Usethis.queryClient.Apply this diff:
- return queryClient - .getQueryData(['blogPosts']) + return this.queryClient + .getQueryData(['blogPosts']) ?.find((d) => d.id === this.postId())
🧹 Nitpick comments (1)
docs/framework/angular/guides/placeholder-query-data.md (1)
39-39: Coerce to number with a transform to avoid string inputs.If
postIdcan come from an attribute (e.g., ), it will be a string. Add Angular’s built-innumberAttributetransform to keep query keys and URLs numeric.Apply within the snippet:
- postId = input.required<number>() + postId = input.required<number>({ transform: numberAttribute })If imports are shown in this doc section, also include:
import { input, numberAttribute } from '@angular/core'
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
docs/framework/angular/guides/placeholder-query-data.md(1 hunks)
🔇 Additional comments (1)
docs/framework/angular/guides/placeholder-query-data.md (1)
39-39: Good move to the signal-basedinput.requiredAPI.This modernizes the example and removes the boilerplate setter. Looks correct with
this.postId()reads in the snippet.
2 participants
Summary by CodeRabbit