fix(core): accept static option in ContentChildren and ViewChildren typings#68803
Open
mohanrajvenkatesan23-04 wants to merge 1 commit into
Conversation
… typings
The `@ContentChildren` and `@ViewChildren` decorator factories accept and
forward `static: boolean` to the underlying query metadata at runtime (it
is spread into the metadata via `...opts`), but the TypeScript decorator
interface typings omitted the option, so passing `{ static: true }` was
rejected by the type-checker even though it worked at runtime.
Add `static?: boolean` to the options bag of both `ContentChildrenDecorator`
and `ViewChildrenDecorator` (call and `new` signatures), mirroring the
existing `static?: boolean` on `ContentChild` / `ViewChild`. Update the
JSDoc with the same wording used by `ViewChild` and refresh the public-API
golden. `ContentChild` already had the option, so it is left unchanged.
Closes angular#36876
|
Thanks for your pull request! It looks like this may be your first contribution to a Google open source project. Before we can look at your pull request, you'll need to sign a Contributor License Agreement (CLA). View this failed invocation of the CLA check for more information. For the most up to date status, view the checks section at the bottom of the pull request. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
PR Checklist
Please check if your PR fulfills the following requirements:
PR Type
What kind of change does this PR introduce?
What is the current behavior?
@ContentChildrenand@ViewChildrendecorator factories accept and forward{ static: true }to the underlying query metadata at runtime (...optsisspread into the metadata object), but the TypeScript decorator option typings
omit
static. As a result, the following compiles withViewChild/ContentChildbut fails type-checking withContentChildren/ViewChildren:Issue Number: #36876
What is the new behavior?
static?: booleanis added to the option bag ofContentChildrenDecoratorand
ViewChildrenDecorator(both call andnewsignatures), matching theexisting
static?: booleanonContentChild/ViewChild. The JSDoc onboth interfaces gains a
**static**bullet using the same wording as theexisting entry on
ViewChild. The public-API golden is updated in lockstep.A regression test in
packages/core/test/acceptance/query_spec.tsinstantiatesa component using
{ static: true }on every one of the four decorators andasserts both that it type-checks and that the query resolves correctly at
runtime.
ContentChildalready had this option, so its typings are untouched.Does this PR introduce a breaking change?
staticwas already accepted at runtime — the typing change only relaxes thetype-checker to match runtime behavior. No existing code is invalidated.
Other information
Public-API golden was updated to reflect the new optional
staticfield.