fix(core): require 'static' flag on queries in typings

This commit makes the static flag on @ViewChild and @ContentChild required. BREAKING CHANGE Starting with v8.0, Angular requires that all @ViewChild and @ContentChild queries have a 'static' flag specifying whether the query is 'static' or 'dynamic'. The compiler previously sorted queries automatically, but in 8.0 developers are required to explicitly specify which behavior is wanted. @ViewChildren and @ContentChildren queries are always dynamic, and so are unaffected. See https://angular.io/guide/static-query-migration for more details
angular · May 23, 2019 · 7c62398 · 7c62398
1 parent 132c61d
commit 7c62398
Show file tree

Hide file tree

Showing 5 changed files with 17 additions and 14 deletions.
diff --git a/packages/compiler/src/core.ts b/packages/compiler/src/core.ts
@@ -29,7 +29,7 @@ export interface Query {
   read: any;
   isViewQuery: boolean;
   selector: any;
-  static?: boolean;
+  static: boolean;
 }
 
 export const createContentChildren = makeMetadataFactory<Query>(

diff --git a/packages/core/src/metadata/di.ts b/packages/core/src/metadata/di.ts
@@ -102,7 +102,7 @@ export interface Query {
   read: any;
   isViewQuery: boolean;
   selector: any;
-  static?: boolean;
+  static: boolean;
 }
 
 /**
@@ -218,8 +218,8 @@ export interface ContentChildDecorator {
    *
    * @Annotation
    */
-  (selector: Type<any>|Function|string, opts?: {read?: any, static?: boolean}): any;
-  new (selector: Type<any>|Function|string, opts?: {read?: any, static?: boolean}): ContentChild;
+  (selector: Type<any>|Function|string, opts?: {read?: any, static: boolean}): any;
+  new (selector: Type<any>|Function|string, opts?: {read?: any, static: boolean}): ContentChild;
 }
 
 /**
@@ -350,8 +350,8 @@ export interface ViewChildDecorator {
    *
    * @Annotation
    */
-  (selector: Type<any>|Function|string, opts?: {read?: any, static?: boolean}): any;
-  new (selector: Type<any>|Function|string, opts?: {read?: any, static?: boolean}): ViewChild;
+  (selector: Type<any>|Function|string, opts?: {read?: any, static: boolean}): any;
+  new (selector: Type<any>|Function|string, opts?: {read?: any, static: boolean}): ViewChild;
 }
 
 /**

diff --git a/packages/core/test/render3/jit/directive_spec.ts b/packages/core/test/render3/jit/directive_spec.ts
@@ -52,7 +52,8 @@ describe('jit directive helper functions', () => {
         descendants: false,
         first: false,
         isViewQuery: false,
-        read: undefined
+        read: undefined,
+        static: false,
       })).toEqual({
         propertyName: 'propName',
         predicate: ['localRef'],
@@ -69,7 +70,8 @@ describe('jit directive helper functions', () => {
         descendants: true,
         first: true,
         isViewQuery: true,
-        read: undefined
+        read: undefined,
+        static: false,
       })).toEqual({
         propertyName: 'propName',
         predicate: ['foo', 'bar', 'baz'],

diff --git a/packages/router/test/regression_integration.spec.ts b/packages/router/test/regression_integration.spec.ts
@@ -75,7 +75,8 @@ describe('Integration', () => {
            // TODO(issue/24571): remove '!'.
            @ViewChild(TemplateRef) templateRef !: TemplateRef<any>;
            // TODO(issue/24571): remove '!'.
-           @ViewChild('container', {read: ViewContainerRef}) container !: ViewContainerRef;
+           @ViewChild('container', {read: ViewContainerRef, static: true})
+           container !: ViewContainerRef;
 
            addLink() {
              this.container.createEmbeddedView(this.templateRef, {$implicit: '/simple'});

diff --git a/tools/public_api_guard/core/core.d.ts b/tools/public_api_guard/core/core.d.ts
@@ -170,11 +170,11 @@ export declare type ContentChild = Query;
 export interface ContentChildDecorator {
     (selector: Type<any> | Function | string, opts?: {
         read?: any;
-        static?: boolean;
+        static: boolean;
     }): any;
     new (selector: Type<any> | Function | string, opts?: {
         read?: any;
-        static?: boolean;
+        static: boolean;
     }): ContentChild;
 }
 
@@ -1104,7 +1104,7 @@ export interface Query {
     isViewQuery: boolean;
     read: any;
     selector: any;
-    static?: boolean;
+    static: boolean;
 }
 
 export declare abstract class Query {
@@ -1384,11 +1384,11 @@ export declare type ViewChild = Query;
 export interface ViewChildDecorator {
     (selector: Type<any> | Function | string, opts?: {
         read?: any;
-        static?: boolean;
+        static: boolean;
     }): any;
     new (selector: Type<any> | Function | string, opts?: {
         read?: any;
-        static?: boolean;
+        static: boolean;
     }): ViewChild;
 }