docs(core): correct type for opts.read (#37626)

The ContentChildren decorator has a metadata property named "read" which
can be used to read a different token from the queried elements. The
documentation incorrectly says "True to read..." when it should say
"Used to read...".

PR Close #37626
This commit is contained in:
Tiep Phan 2020-06-17 22:35:14 +07:00 committed by Misko Hevery
parent 53e95233c3
commit 1d844b9bd8
1 changed files with 4 additions and 4 deletions

View File

@ -140,7 +140,7 @@ export interface ContentChildrenDecorator {
* *
* * **selector** - The directive type or the name used for querying. * * **selector** - The directive type or the name used for querying.
* * **descendants** - True to include all descendants, otherwise include only direct children. * * **descendants** - True to include all descendants, otherwise include only direct children.
* * **read** - True to read a different token from the queried elements. * * **read** - Used to read a different token from the queried elements.
* *
* @usageNotes * @usageNotes
* *
@ -206,7 +206,7 @@ export interface ContentChildDecorator {
* **Metadata Properties**: * **Metadata Properties**:
* *
* * **selector** - The directive type or the name used for querying. * * **selector** - The directive type or the name used for querying.
* * **read** - True to read a different token from the queried element. * * **read** - Used to read a different token from the queried element.
* * **static** - True to resolve query results before change detection runs, * * **static** - True to resolve query results before change detection runs,
* false to resolve after change detection. Defaults to false. * false to resolve after change detection. Defaults to false.
* *
@ -267,7 +267,7 @@ export interface ViewChildrenDecorator {
* **Metadata Properties**: * **Metadata Properties**:
* *
* * **selector** - The directive type or the name used for querying. * * **selector** - The directive type or the name used for querying.
* * **read** - True to read a different token from the queried elements. * * **read** - Used to read a different token from the queried elements.
* *
* @usageNotes * @usageNotes
* *
@ -322,7 +322,7 @@ export interface ViewChildDecorator {
* **Metadata Properties**: * **Metadata Properties**:
* *
* * **selector** - The directive type or the name used for querying. * * **selector** - The directive type or the name used for querying.
* * **read** - True to read a different token from the queried elements. * * **read** - Used to read a different token from the queried elements.
* * **static** - True to resolve query results before change detection runs, * * **static** - True to resolve query results before change detection runs,
* false to resolve after change detection. Defaults to false. * false to resolve after change detection. Defaults to false.
* *