Welcome to Knowledge Base!

KB at your finger tips

This is one stop global knowledge base where you can learn about all the products, solutions and support features.

Categories
All

Web-Angular

Angular - Ahead-of-time (AOT) compilation

Ahead-of-time (AOT) compilation link

An Angular application consists mainly of components and their HTML templates. Because the components and templates provided by Angular cannot be understood by the browser directly, Angular applications require a compilation process before they can run in a browser.

The Angular ahead-of-time (AOT) compiler converts your Angular HTML and TypeScript code into efficient JavaScript code during the build phase before the browser downloads and runs that code. Compiling your application during the build process provides a faster rendering in the browser.

This guide explains how to specify metadata and apply available compiler options to compile your applications efficiently using the AOT compiler.

Watch Alex Rickabaugh explain the Angular compiler at AngularConnect 2019.

Here are some reasons you might want to use AOT.

Reasons Details
Faster rendering With AOT, the browser downloads a pre-compiled version of the application. The browser loads executable code so it can render the application immediately, without waiting to compile the application first.
Fewer asynchronous requests The compiler inlines external HTML templates and CSS style sheets within the application JavaScript, eliminating separate ajax requests for those source files.
Smaller Angular framework download size There's no need to download the Angular compiler if the application is already compiled. The compiler is roughly half of Angular itself, so omitting it dramatically reduces the application payload.
Detect template errors earlier The AOT compiler detects and reports template binding errors during the build step before users can see them.
Better security AOT compiles HTML templates and components into JavaScript files long before they are served to the client. With no templates to read and no risky client-side HTML or JavaScript evaluation, there are fewer opportunities for injection attacks.

Choosing a compiler link

Angular offers two ways to compile your application:

Angular compile Details
Just-in-Time (JIT) Compiles your application in the browser at runtime. This was the default until Angular 8.
Ahead-of-Time (AOT) Compiles your application and libraries at build time. This is the default starting in Angular 9.

When you run the ng build (build only) or ng serve (build and serve locally) CLI commands, the type of compilation (JIT or AOT) depends on the value of the aot property in your build configuration specified in angular.json . By default, aot is set to true for new CLI applications.

See the CLI command reference and Building and serving Angular apps for more information.

How AOT works link

The Angular AOT compiler extracts metadata to interpret the parts of the application that Angular is supposed to manage. You can specify the metadata explicitly in decorators such as @Component() and @Input() , or implicitly in the constructor declarations of the decorated classes. The metadata tells Angular how to construct instances of your application classes and interact with them at runtime.

In the following example, the @Component() metadata object and the class constructor tell Angular how to create and display an instance of TypicalComponent .

      
      @Component({
  selector: 'app-typical',
  template: '<div>A typical component for {{data.name}}</div>'
})
export class TypicalComponent {
  @Input() data: TypicalData;
  constructor(private someService: SomeService) {  }
}
    

The Angular compiler extracts the metadata once and generates a factory for TypicalComponent . When it needs to create a TypicalComponent instance, Angular calls the factory, which produces a new visual element, bound to a new instance of the component class with its injected dependency.

Compilation phases link

There are three phases of AOT compilation.

Phase Details
1 code analysis In this phase, the TypeScript compiler and AOT collector create a representation of the source. The collector does not attempt to interpret the metadata it collects. It represents the metadata as best it can and records errors when it detects a metadata syntax violation.
2 code generation In this phase, the compiler's StaticReflector interprets the metadata collected in phase 1, performs additional validation of the metadata, and throws an error if it detects a metadata restriction violation.
3 template type checking In this optional phase, the Angular template compiler uses the TypeScript compiler to validate the binding expressions in templates. You can enable this phase explicitly by setting the fullTemplateTypeCheck configuration option; see Angular compiler options.

Metadata restrictions link

You write metadata in a subset of TypeScript that must conform to the following general constraints:

  • Limit expression syntax to the supported subset of JavaScript
  • Only reference exported symbols after code folding
  • Only call functions supported by the compiler
  • Decorated and data-bound class members must be public

For additional guidelines and instructions on preparing an application for AOT compilation, see Angular: Writing AOT-friendly applications.

Errors in AOT compilation commonly occur because of metadata that does not conform to the compiler's requirements (as described more fully below). For help in understanding and resolving these problems, see AOT Metadata Errors.

Configuring AOT compilation link

You can provide options in the TypeScript configuration file that controls the compilation process. See Angular compiler options for a complete list of available options.

Phase 1: Code analysis link

The TypeScript compiler does some of the analytic work of the first phase. It emits the .d.ts type definition files with type information that the AOT compiler needs to generate application code. At the same time, the AOT collector analyzes the metadata recorded in the Angular decorators and outputs metadata information in .metadata.json files, one per .d.ts file.

You can think of .metadata.json as a diagram of the overall structure of a decorator's metadata, represented as an abstract syntax tree (AST).

Angular's schema.ts describes the JSON format as a collection of TypeScript interfaces.

Expression syntax limitations link

The AOT collector only understands a subset of JavaScript. Define metadata objects with the following limited syntax:

Syntax Example
Literal object {cherry: true, apple: true, mincemeat: false}
Literal array ['cherries', 'flour', 'sugar']
Spread in literal array ['apples', 'flour', ...]
Calls bake(ingredients)
New new Oven()
Property access pie.slice
Array index ingredients[0]
Identity reference Component
A template string `pie is ${multiplier} times better than cake`
Literal string 'pi'
Literal number 3.14153265
Literal boolean true
Literal null null
Supported prefix operator !cake
Supported binary operator a+b
Conditional operator a ? b : c
Parentheses (a+b)

If an expression uses unsupported syntax, the collector writes an error node to the .metadata.json file. The compiler later reports the error if it needs that piece of metadata to generate the application code.

If you want ngc to report syntax errors immediately rather than produce a .metadata.json file with errors, set the strictMetadataEmit option in the TypeScript configuration file.

      
      "angularCompilerOptions": {
  
  "strictMetadataEmit" : true
}
    

Angular libraries have this option to ensure that all Angular .metadata.json files are clean and it is a best practice to do the same when building your own libraries.

No arrow functions link

The AOT compiler does not support function expressions and arrow functions, also called lambda functions.

Consider the following component decorator:

      
      @Component({
  
  providers: [{provide: server, useFactory: () => new Server()}]
})
    

The AOT collector does not support the arrow function, () => new Server() , in a metadata expression. It generates an error node in place of the function. When the compiler later interprets this node, it reports an error that invites you to turn the arrow function into an exported function .

You can fix the error by converting to this:

      
      export function serverFactory() {
  return new Server();
}

@Component({
  
  providers: [{provide: server, useFactory: serverFactory}]
})
    

In version 5 and later, the compiler automatically performs this rewriting while emitting the .js file.

Code folding link

The compiler can only resolve references to exported symbols. The collector, however, can evaluate an expression during collection and record the result in the .metadata.json , rather than the original expression. This allows you to make limited use of non-exported symbols within expressions.

For example, the collector can evaluate the expression 1 + 2 + 3 + 4 and replace it with the result, 10 . This process is called folding . An expression that can be reduced in this manner is foldable .

The collector can evaluate references to module-local const declarations and initialized var and let declarations, effectively removing them from the .metadata.json file.

Consider the following component definition:

      
      const template = '<div>{{hero.name}}</div>';

@Component({
  selector: 'app-hero',
  template: template
})
export class HeroComponent {
  @Input() hero: Hero;
}
    

The compiler could not refer to the template constant because it isn't exported. The collector, however, can fold the template constant into the metadata definition by in-lining its contents. The effect is the same as if you had written:

      
      @Component({
  selector: 'app-hero',
  template: '<div>{{hero.name}}</div>'
})
export class HeroComponent {
  @Input() hero: Hero;
}
    

There is no longer a reference to template and, therefore, nothing to trouble the compiler when it later interprets the collector's output in .metadata.json .

You can take this example a step further by including the template constant in another expression:

      
      const template = '<div>{{hero.name}}</div>';

@Component({
  selector: 'app-hero',
  template: template + '<div>{{hero.title}}</div>'
})
export class HeroComponent {
  @Input() hero: Hero;
}
    

The collector reduces this expression to its equivalent folded string:

      
      '<div>{{hero.name}}</div><div>{{hero.title}}</div>'
    

Foldable syntax link

The following table describes which expressions the collector can and cannot fold:

Syntax Foldable
Literal object yes
Literal array yes
Spread in literal array no
Calls no
New no
Property access yes, if target is foldable
Array index yes, if target and index are foldable
Identity reference yes, if it is a reference to a local
A template with no substitutions yes
A template with substitutions yes, if the substitutions are foldable
Literal string yes
Literal number yes
Literal boolean yes
Literal null yes
Supported prefix operator yes, if operand is foldable
Supported binary operator yes, if both left and right are foldable
Conditional operator yes, if condition is foldable
Parentheses yes, if the expression is foldable

If an expression is not foldable, the collector writes it to .metadata.json as an AST for the compiler to resolve.

Phase 2: code generation link

The collector makes no attempt to understand the metadata that it collects and outputs to .metadata.json . It represents the metadata as best it can and records errors when it detects a metadata syntax violation. It's the compiler's job to interpret the .metadata.json in the code generation phase.

The compiler understands all syntax forms that the collector supports, but it may reject syntactically correct metadata if the semantics violate compiler rules.

Public symbols link

The compiler can only reference exported symbols .

  • Decorated component class members must be public. You cannot make an @Input() property private or protected.

  • Data bound properties must also be public

Supported classes and functions link

The collector can represent a function call or object creation with new as long as the syntax is valid. The compiler, however, can later refuse to generate a call to a particular function or creation of a particular object.

The compiler can only create instances of certain classes, supports only core decorators, and only supports calls to macros (functions or static methods) that return expressions.

Compiler action Details
New instances The compiler only allows metadata that create instances of the class InjectionToken from @angular/core .
Supported decorators The compiler only supports metadata for the Angular decorators in the @angular/core module.
Function calls Factory functions must be exported, named functions. The AOT compiler does not support lambda expressions ("arrow functions") for factory functions.

Functions and static method calls link

The collector accepts any function or static method that contains a single return statement. The compiler, however, only supports macros in the form of functions or static methods that return an expression .

For example, consider the following function:

      
      export function wrapInArray<T>(value: T): T[] {
  return [value];
}
    

You can call the wrapInArray in a metadata definition because it returns the value of an expression that conforms to the compiler's restrictive JavaScript subset.

You might use wrapInArray() like this:

      
      @NgModule({
  declarations: wrapInArray(TypicalComponent)
})
export class TypicalModule {}
    

The compiler treats this usage as if you had written:

      
      @NgModule({
  declarations: [TypicalComponent]
})
export class TypicalModule {}
    

The Angular RouterModule exports two macro static methods, forRoot and forChild , to help declare root and child routes. Review the source code for these methods to see how macros can simplify configuration of complex NgModules.

Metadata rewriting link

The compiler treats object literals containing the fields useClass , useValue , useFactory , and data specially, converting the expression initializing one of these fields into an exported variable that replaces the expression. This process of rewriting these expressions removes all the restrictions on what can be in them because the compiler doesn't need to know the expression's value —it just needs to be able to generate a reference to the value.

You might write something like:

      
      class TypicalServer {

}

@NgModule({
  providers: [{provide: SERVER, useFactory: () => TypicalServer}]
})
export class TypicalModule {}
    

Without rewriting, this would be invalid because lambdas are not supported and TypicalServer is not exported. To allow this, the compiler automatically rewrites this to something like:

      
      class TypicalServer {

}

export const θ0 = () => new TypicalServer();

@NgModule({
  providers: [{provide: SERVER, useFactory: θ0}]
})
export class TypicalModule {}
    

This allows the compiler to generate a reference to θ0 in the factory without having to know what the value of θ0 contains.

The compiler does the rewriting during the emit of the .js file. It does not, however, rewrite the .d.ts file, so TypeScript doesn't recognize it as being an export. And it does not interfere with the ES module's exported API.

Phase 3: Template type checking link

One of the Angular compiler's most helpful features is the ability to type-check expressions within templates, and catch any errors before they cause crashes at runtime. In the template type-checking phase, the Angular template compiler uses the TypeScript compiler to validate the binding expressions in templates.

Enable this phase explicitly by adding the compiler option "fullTemplateTypeCheck" in the "angularCompilerOptions" of the project's TypeScript configuration file (see Angular Compiler Options).

Template validation produces error messages when a type error is detected in a template binding expression, similar to how type errors are reported by the TypeScript compiler against code in a .ts file.

For example, consider the following component:

      
      @Component({
  selector: 'my-component',
  template: '{{person.addresss.street}}'
})
class MyComponent {
  person?: Person;
}
    

This produces the following error:

      
      my.component.ts.MyComponent.html(1,1): : Property 'addresss' does not exist on type 'Person'. Did you mean 'address'?
    

The file name reported in the error message, my.component.ts.MyComponent.html , is a synthetic file generated by the template compiler that holds contents of the MyComponent class template. The compiler never writes this file to disk. The line and column numbers are relative to the template string in the @Component annotation of the class, MyComponent in this case. If a component uses templateUrl instead of template , the errors are reported in the HTML file referenced by the templateUrl instead of a synthetic file.

The error location is the beginning of the text node that contains the interpolation expression with the error. If the error is in an attribute binding such as [value]="person.address.street" , the error location is the location of the attribute that contains the error.

The validation uses the TypeScript type checker and the options supplied to the TypeScript compiler to control how detailed the type validation is. For example, if the strictTypeChecks is specified, the error

      
      my.component.ts.MyComponent.html(1,1): : Object is possibly 'undefined'
    

is reported as well as the above error message.

Type narrowing link

The expression used in an ngIf directive is used to narrow type unions in the Angular template compiler, the same way the if expression does in TypeScript. For example, to avoid Object is possibly 'undefined' error in the template above, modify it to only emit the interpolation if the value of person is initialized as shown below:

      
      @Component({
  selector: 'my-component',
  template: ' {{person.address.street}} '
})
class MyComponent {
  person?: Person;
}
    

Using *ngIf allows the TypeScript compiler to infer that the person used in the binding expression will never be undefined .

For more information about input type narrowing, see Improving template type checking for custom directives.

Non-null type assertion operator link

Use the non-null type assertion operator to suppress the Object is possibly 'undefined' error when it is inconvenient to use *ngIf or when some constraint in the component ensures that the expression is always non-null when the binding expression is interpolated.

In the following example, the person and address properties are always set together, implying that address is always non-null if person is non-null. There is no convenient way to describe this constraint to TypeScript and the template compiler, but the error is suppressed in the example by using address!.street .

      
      @Component({
  selector: 'my-component',
  template: '<span *ngIf="person"> {{person.name}} lives on {{address!.street}} </span>'
})
class MyComponent {
  person?: Person;
  address?: Address;

  setData(person: Person, address: Address) {
    this.person = person;
    this.address = address;
  }
}
    

The non-null assertion operator should be used sparingly as refactoring of the component might break this constraint.

In this example it is recommended to include the checking of address in the *ngIf as shown below:

      
      @Component({
  selector: 'my-component',
  template: '<span *ngIf="person && address"> {{person.name}} lives on {{address.street}} </span>'
})
class MyComponent {
  person?: Person;
  address?: Address;

  setData(person: Person, address: Address) {
    this.person = person;
    this.address = address;
  }
}
    
Last reviewed on Mon Feb 28 2022

Angular - AOT metadata errors

AOT metadata errors link

The following are metadata errors you may encounter, with explanations and suggested corrections.

Expression form not supported
Reference to a local (non-exported) symbol
Only initialized variables and constants
Reference to a non-exported class
Reference to a non-exported function
Function calls are not supported
Destructured variable or constant not supported
Could not resolve type
Name expected
Unsupported enum member name
Tagged template expressions are not supported
Symbol reference expected

Expression form not supported link

The compiler encountered an expression it didn't understand while evaluating Angular metadata.

Language features outside of the compiler's restricted expression syntax can produce this error, as seen in the following example:

      
      // ERROR
export class Fooish {  }

const prop = typeof Fooish; // typeof is not valid in metadata
  
  // bracket notation is not valid in metadata
  { provide: 'token', useValue: { [prop]: 'value' } };
  
    

You can use typeof and bracket notation in normal application code. You just can't use those features within expressions that define Angular metadata.

Avoid this error by sticking to the compiler's restricted expression syntax when writing Angular metadata and be wary of new or unusual TypeScript features.

Reference to a local (non-exported) symbol link

Reference to a local (non-exported) symbol 'symbol name'. Consider exporting the symbol.

The compiler encountered a referenced to a locally defined symbol that either wasn't exported or wasn't initialized.

Here's a provider example of the problem.

      
      // ERROR
let foo: number; // neither exported nor initialized

@Component({
  selector: 'my-component',
  template:  ,
  providers: [
    { provide: Foo, useValue: foo }
  ]
})
export class MyComponent {}
    

The compiler generates the component factory, which includes the useValue provider code, in a separate module. That factory module can't reach back to this source module to access the local (non-exported) foo variable.

You could fix the problem by initializing foo .

      
      let foo = 42; // initialized
    

The compiler will fold the expression into the provider as if you had written this.

      
      providers: [
  { provide: Foo, useValue: 42 }
]
    

Alternatively, you can fix it by exporting foo with the expectation that foo will be assigned at runtime when you actually know its value.

      
      // CORRECTED
export let foo: number; // exported

@Component({
  selector: 'my-component',
  template:  ,
  providers: [
    { provide: Foo, useValue: foo }
  ]
})
export class MyComponent {}
    

Adding export often works for variables referenced in metadata such as providers and animations because the compiler can generate references to the exported variables in these expressions. It doesn't need the values of those variables.

Adding export doesn't work when the compiler needs the actual value in order to generate code. For example, it doesn't work for the template property.

      
      // ERROR
export let someTemplate: string; // exported but not initialized

@Component({
  selector: 'my-component',
  template: someTemplate
})
export class MyComponent {}
    

The compiler needs the value of the template property right now to generate the component factory. The variable reference alone is insufficient. Prefixing the declaration with export merely produces a new error, " Only initialized variables and constants can be referenced ".

Only initialized variables and constants link

Only initialized variables and constants can be referenced because the value of this variable is needed by the template compiler.

The compiler found a reference to an exported variable or static field that wasn't initialized. It needs the value of that variable to generate code.

The following example tries to set the component's template property to the value of the exported someTemplate variable which is declared but unassigned .

      
      // ERROR
export let someTemplate: string;

@Component({
  selector: 'my-component',
  template: someTemplate
})
export class MyComponent {}
    

You'd also get this error if you imported someTemplate from some other module and neglected to initialize it there.

      
      // ERROR - not initialized there either
import { someTemplate } from './config';

@Component({
  selector: 'my-component',
  template: someTemplate
})
export class MyComponent {}
    

The compiler cannot wait until runtime to get the template information. It must statically derive the value of the someTemplate variable from the source code so that it can generate the component factory, which includes instructions for building the element based on the template.

To correct this error, provide the initial value of the variable in an initializer clause on the same line .

      
      // CORRECTED
export let someTemplate = '<h1>Greetings from Angular</h1>';

@Component({
  selector: 'my-component',
  template: someTemplate
})
export class MyComponent {}
    

Reference to a non-exported class link

Reference to a non-exported class <class name> . Consider exporting the class.

Metadata referenced a class that wasn't exported.

For example, you may have defined a class and used it as an injection token in a providers array but neglected to export that class.

      
      // ERROR
abstract class MyStrategy { }

  
  providers: [
    { provide: MyStrategy, useValue:  }
  ]
  
    

Angular generates a class factory in a separate module and that factory can only access exported classes. To correct this error, export the referenced class.

      
      // CORRECTED
export abstract class MyStrategy { }

  
  providers: [
    { provide: MyStrategy, useValue:  }
  ]
  
    

Reference to a non-exported function link

Metadata referenced a function that wasn't exported.

For example, you may have set a providers useFactory property to a locally defined function that you neglected to export.

      
      // ERROR
function myStrategy() {  }

  
  providers: [
    { provide: MyStrategy, useFactory: myStrategy }
  ]
  
    

Angular generates a class factory in a separate module and that factory can only access exported functions. To correct this error, export the function.

      
      // CORRECTED
export function myStrategy() {  }

  
  providers: [
    { provide: MyStrategy, useFactory: myStrategy }
  ]
  
    

Function calls are not supported link

Function calls are not supported. Consider replacing the function or lambda with a reference to an exported function.

The compiler does not currently support function expressions or lambda functions. For example, you cannot set a provider's useFactory to an anonymous function or arrow function like this.

      
      // ERROR
  
  providers: [
    { provide: MyStrategy, useFactory: function() {  } },
    { provide: OtherStrategy, useFactory: () => {  } }
  ]
  
    

You also get this error if you call a function or method in a provider's useValue .

      
      // ERROR
import { calculateValue } from './utilities';

  
  providers: [
    { provide: SomeValue, useValue: calculateValue() }
  ]
  
    

To correct this error, export a function from the module and refer to the function in a useFactory provider instead.

      
      // CORRECTED
import { calculateValue } from './utilities';

export function myStrategy() {  }
export function otherStrategy() {  }
export function someValueFactory() {
  return calculateValue();
}
  
  providers: [
    { provide: MyStrategy, useFactory: myStrategy },
    { provide: OtherStrategy, useFactory: otherStrategy },
    { provide: SomeValue, useFactory: someValueFactory }
  ]
  
    

Destructured variable or constant not supported link

Referencing an exported destructured variable or constant is not supported by the template compiler. Consider simplifying this to avoid destructuring.

The compiler does not support references to variables assigned by destructuring.

For example, you cannot write something like this:

      
      // ERROR
import { configuration } from './configuration';

// destructured assignment to foo and bar
const {foo, bar} = configuration;
  
  providers: [
    {provide: Foo, useValue: foo},
    {provide: Bar, useValue: bar},
  ]
  
    

To correct this error, refer to non-destructured values.

      
      // CORRECTED
import { configuration } from './configuration';
  
  providers: [
    {provide: Foo, useValue: configuration.foo},
    {provide: Bar, useValue: configuration.bar},
  ]
  
    

Could not resolve type link

The compiler encountered a type and can't determine which module exports that type.

This can happen if you refer to an ambient type. For example, the Window type is an ambient type declared in the global .d.ts file.

You'll get an error if you reference it in the component constructor, which the compiler must statically analyze.

      
      // ERROR
@Component({ })
export class MyComponent {
  constructor (private win: Window) {  }
}
    

TypeScript understands ambient types so you don't import them. The Angular compiler does not understand a type that you neglect to export or import.

In this case, the compiler doesn't understand how to inject something with the Window token.

Do not refer to ambient types in metadata expressions.

If you must inject an instance of an ambient type, you can finesse the problem in four steps:

  1. Create an injection token for an instance of the ambient type.
  2. Create a factory function that returns that instance.
  3. Add a useFactory provider with that factory function.
  4. Use @Inject to inject the instance.

Here's an illustrative example.

      
      // CORRECTED
import { Inject } from '@angular/core';

export const WINDOW = new InjectionToken('Window');
export function _window() { return window; }

@Component({
  
  providers: [
    { provide: WINDOW, useFactory: _window }
  ]
})
export class MyComponent {
  constructor (@Inject(WINDOW) private win: Window) {  }
}
    

The Window type in the constructor is no longer a problem for the compiler because it uses the @Inject(WINDOW) to generate the injection code.

Angular does something similar with the DOCUMENT token so you can inject the browser's document object (or an abstraction of it, depending upon the platform in which the application runs).

      
      import { Inject }   from '@angular/core';
import { DOCUMENT } from '@angular/common';

@Component({  })
export class MyComponent {
  constructor (@Inject(DOCUMENT) private doc: Document) {  }
}
    

Name expected link

The compiler expected a name in an expression it was evaluating.

This can happen if you use a number as a property name as in the following example.

      
      // ERROR
provider: [{ provide: Foo, useValue: { 0: 'test' } }]
    

Change the name of the property to something non-numeric.

      
      // CORRECTED
provider: [{ provide: Foo, useValue: { '0': 'test' } }]
    

Unsupported enum member name link

Angular couldn't determine the value of the enum member that you referenced in metadata.

The compiler can understand simple enum values but not complex values such as those derived from computed properties.

      
      // ERROR
enum Colors {
  Red = 1,
  White,
  Blue = "Blue".length // computed
}

  
  providers: [
    { provide: BaseColor,   useValue: Colors.White } // ok
    { provide: DangerColor, useValue: Colors.Red }   // ok
    { provide: StrongColor, useValue: Colors.Blue }  // bad
  ]
  
    

Avoid referring to enums with complicated initializers or computed properties.

Tagged template expressions are not supported link

Tagged template expressions are not supported in metadata.

The compiler encountered a JavaScript ES2015 tagged template expression such as the following.

      
      // ERROR
const expression = 'funky';
const raw = String.raw`A tagged template ${expression} string`;
 
 template: '<div>' + raw + '</div>'
 
    

String.raw() is a tag function native to JavaScript ES2015.

The AOT compiler does not support tagged template expressions; avoid them in metadata expressions.

Symbol reference expected link

The compiler expected a reference to a symbol at the location specified in the error message.

This error can occur if you use an expression in the extends clause of a class.

Last reviewed on Mon Feb 28 2022
Read article

Angular - App shell

App shell link

Application shell is a way to render a portion of your application using a route at build time. It can improve the user experience by quickly launching a static rendered page (a skeleton common to all pages) while the browser downloads the full client version and switches to it automatically after the code loads.

This gives users a meaningful first paint of your application that appears quickly because the browser can render the HTML and CSS without the need to initialize any JavaScript.

Learn more in The App Shell Model.

Step 1: Prepare the application link

Do this with the following Angular CLI command:

      
      ng new my-app --routing
    

For an existing application, you have to manually add the RouterModule and defining a <router-outlet> within your application.

Step 2: Create the application shell link

Use the Angular CLI to automatically create the application shell.

      
      ng generate app-shell
    

For more information about this command, see App shell command.

After running this command you can see that the angular.json configuration file has been updated to add two new targets, with a few other changes.

      
      "server": {
  "builder": "@angular-devkit/build-angular:server",
  "defaultConfiguration": "production",
  "options": {
    "outputPath": "dist/my-app/server",
    "main": "src/main.server.ts",
    "tsConfig": "tsconfig.server.json"
  },
  "configurations": {
    "development": {
      "outputHashing": "none",
    },
    "production": {
      "outputHashing": "media",
      "fileReplacements": [
        {
          "replace": "src/environments/environment.ts",
          "with": "src/environments/environment.prod.ts"
        }
      ],
      "sourceMap": false,
      "optimization": true
    }
  }
},
"app-shell": {
  "builder": "@angular-devkit/build-angular:app-shell",
  "defaultConfiguration": "production",
  "options": {
    "route": "shell"
  },
  "configurations": {
    "development": {
      "browserTarget": "my-app:build:development",
      "serverTarget": "my-app:server:development",
    },
    "production": {
      "browserTarget": "my-app:build:production",
      "serverTarget": "my-app:server:production"
    }
  }
}
    

Step 3: Verify the application is built with the shell content link

Use the Angular CLI to build the app-shell target.

      
      ng run my-app:app-shell:development
    

Or to use the production configuration.

      
      ng run my-app:app-shell:production
    

To verify the build output, open dist/my-app/browser/index.html . Look for default text app-shell works! to show that the application shell route was rendered as part of the output.

Last reviewed on Mon Feb 28 2022
Read article

Angular - Introduction to components and templates

Introduction to components and templates link

A component controls a patch of screen called a view . It consists of a TypeScript class, an HTML template, and a CSS style sheet. The TypeScript class defines the interaction of the HTML template and the rendered DOM structure, while the style sheet describes its appearance.

An Angular application uses individual components to define and control different aspects of the application. For example, an application could include components to describe:

  • The application root with the navigation links
  • The list of heroes
  • The hero editor

In the following example, the HeroListComponent class includes:

  • A heroes property that holds an array of heroes.
  • A selectedHero property that holds the last hero selected by the user.
  • A selectHero() method sets a selectedHero property when the user clicks to choose a hero from that list.

The component initializes the heroes property by using the HeroService service, which is a TypeScript parameter property on the constructor. Angular's dependency injection system provides the HeroService service to the component.

src/app/hero-list.component.ts (class)
      
      export class HeroListComponent implements OnInit {
  heroes: Hero[] = [];
  selectedHero: Hero | undefined;

  constructor(private service: HeroService) { }

  ngOnInit() {
    this.heroes = this.service.getHeroes();
  }

  selectHero(hero: Hero) { this.selectedHero = hero; }
}
    

Angular creates, updates, and destroys components as the user moves through the application. Your application can take action at each moment in this lifecycle through optional lifecycle hooks, like ngOnInit() .

Component metadata link

The @Component decorator identifies the class immediately below it as a component class, and specifies its metadata. In the example code below, you can see that HeroListComponent is just a class, with no special Angular notation or syntax at all. It's not a component until you mark it as one with the @Component decorator.

The metadata for a component tells Angular where to get the major building blocks that it needs to create and present the component and its view. In particular, it associates a template with the component, either directly with inline code, or by reference. Together, the component and its template describe a view .

In addition to containing or pointing to the template, the @Component metadata configures, for example, how the component can be referenced in HTML and what services it requires.

Here's an example of basic metadata for HeroListComponent .

src/app/hero-list.component.ts (metadata)
      
      @Component({
  selector:    'app-hero-list',
  templateUrl: './hero-list.component.html',
  providers:  [ HeroService ]
})
export class HeroListComponent implements OnInit {
  /* . . . */
}
    

This example shows some of the most useful @Component configuration options:

Configuration options Details
selector A CSS selector that tells Angular to create and insert an instance of this component wherever it finds the corresponding tag in template HTML. For example, if an application's HTML contains <app-hero-list></app-hero-list> , then Angular inserts an instance of the HeroListComponent view between those tags.
templateUrl The module-relative address of this component's HTML template. Alternatively, you can provide the HTML template inline, as the value of the template property. This template defines the component's host view .
providers An array of providers for services that the component requires. In the example, this tells Angular how to provide the HeroService instance that the component's constructor uses to get the list of heroes to display.

Templates and views link

You define a component's view with its companion template. A template is a form of HTML that tells Angular how to render the component.

Views are typically organized hierarchically, allowing you to modify or show and hide entire UI sections or pages as a unit. The template immediately associated with a component defines that component's host view . The component can also define a view hierarchy , which contains embedded views , hosted by other components.

A view hierarchy can include views from components in the same NgModule and from those in different NgModules.

Template syntax link

A template looks like regular HTML, except that it also contains Angular template syntax, which alters the HTML based on your application's logic and the state of application and DOM data. Your template can use data binding to coordinate the application and DOM data, pipes to transform data before it is displayed, and directives to apply application logic to what gets displayed.

For example, here is a template for the Tutorial's HeroListComponent .

src/app/hero-list.component.html
      
      <h2>Hero List</h2>

<p><em>Select a hero from the list to see details.</em></p>
<ul>
  <li *ngFor="let hero of heroes">
    <button type="button" (click)="selectHero(hero)">
      {{hero.name}}
    </button>
  </li>
</ul>

<app-hero-detail *ngIf="selectedHero" [hero]="selectedHero"></app-hero-detail>
    

This template uses typical HTML elements like <h2> and <p> . It also includes Angular template-syntax elements, *ngFor , {{hero.name}} , (click) , [hero] , and <app-hero-detail> . The template-syntax elements tell Angular how to render the HTML to the screen, using program logic and data.

  • The *ngFor directive tells Angular to iterate over a list

  • {{hero.name}} , (click) , and [hero] bind program data to and from the DOM, responding to user input. See more about data binding below.

  • The <app-hero-detail> element tag in the example represents a new component, HeroDetailComponent . The HeroDetailComponent defines the hero-detail portion of the rendered DOM structure specified by the HeroListComponent component.

    Notice how these custom components mix with native HTML.

Data binding link

Without a framework, you would be responsible for pushing data values into the HTML controls and turning user responses into actions and value updates. Writing such push and pull logic by hand is tedious, error-prone, and a nightmare to read, as any experienced front-end JavaScript programmer can attest.

Angular supports two-way data binding , a mechanism for coordinating the parts of a template with the parts of a component. Add binding markup to the template HTML to tell Angular how to connect both sides.

The following diagram shows the four forms of data binding markup. Each form has a direction: to the DOM, from the DOM, or both.

This example from the HeroListComponent template uses three of these forms.

src/app/hero-list.component.html (binding)
      
      <app-hero-detail [hero]="selectedHero"></app-hero-detail>
<button type="button" (click)="selectHero(hero)">
  {{hero.name}}
</button>
    
Data bindings Details
[hero] property binding Passes the value of selectedHero from the parent HeroListComponent to the hero property of the child HeroDetailComponent .
(click) event binding Calls the component's selectHero method when the user clicks a hero's name.
{{hero.name}} interpolation Displays the component's hero.name property value within the <button> element.

Two-way data binding (used mainly in template-driven forms) combines property and event binding in a single notation. Here's an example from the HeroDetailComponent template that uses two-way data binding with the ngModel directive.

src/app/hero-detail.component.html (ngModel)
      
      <input type="text" id="hero-name" [(ngModel)]="hero.name">
    

In two-way binding, a data property value flows to the input box from the component as with property binding. The user's changes also flow back to the component, resetting the property to the latest value, as with event binding.

Angular processes all data bindings once for each JavaScript event cycle, from the root of the application component tree through all child components.

Data binding plays an important role in communication between a template and its component, and is also important for communication between parent and child components.

Pipes link

Angular pipes let you declare display-value transformations in your template HTML. A class with the @Pipe decorator defines a function that transforms input values to output values for display in a view.

Angular defines various pipes, such as the date pipe and currency pipe. For a complete list, see the Pipes API list. You can also define new pipes.

To specify a value transformation in an HTML template, use the pipe operator ( | ).

      
      {{interpolated_value | pipe_name}}
    

You can chain pipes, sending the output of one pipe function to be transformed by another pipe function. A pipe can also take arguments that control how it performs its transformation. For example, you can pass the desired format to the date pipe.

      
      <!-- Default format: output 'Jun 15, 2015'-->
<p>Today is {{today | date}}</p>

<!-- fullDate format: output 'Monday, June 15, 2015'-->
<p>The date is {{today | date:'fullDate'}}</p>

<!-- shortTime format: output '9:43 AM'-->
<p>The time is {{today | date:'shortTime'}}</p>
    

Directives link

Angular templates are dynamic . When Angular renders them, it transforms the DOM according to the instructions given by directives . A directive is a class with a @Directive() decorator.

A component is technically a directive. However, components are so distinctive and central to Angular applications that Angular defines the @Component() decorator, which extends the @Directive() decorator with template-oriented features.

In addition to components, there are two other kinds of directives: structural and attribute . Angular defines a number of directives of both kinds, and you can define your own using the @Directive() decorator.

Just as for components, the metadata for a directive associates the decorated class with a selector element that you use to insert it into HTML. In templates, directives typically appear within an element tag as attributes, either by name or as the target of an assignment or a binding.

Structural directives link

Structural directives alter layout by adding, removing, and replacing elements in the DOM. The example template uses two built-in structural directives to add application logic to how the view is rendered.

src/app/hero-list.component.html (structural)
      
      <li *ngFor="let hero of heroes"></li>
<app-hero-detail *ngIf="selectedHero"></app-hero-detail>
    
Directives Details
*ngFor An iterative , which tells Angular to create one <li> per hero in the heroes list.
*ngIf A conditional , which includes the HeroDetail component only if a selected hero exists.

Attribute directives link

Attribute directives alter the appearance or behavior of an existing element. In templates they look like regular HTML attributes, hence the name.

The ngModel directive, which implements two-way data binding, is an example of an attribute directive. ngModel modifies the behavior of an existing element (typically <input> ) by setting its display value property and responding to change events.

src/app/hero-detail.component.html (ngModel)
      
      <input type="text" id="hero-name" [(ngModel)]="hero.name">
    

Angular includes pre-defined directives that change:

  • The layout structure, such as ngSwitch, and
  • Aspects of DOM elements and components, such as ngStyle and ngClass.

Learn more in the Attribute Directives and Structural Directives guides.

Last reviewed on Mon Feb 28 2022
Read article

Angular - Introduction to modules

Introduction to modules link

Angular applications are modular and Angular has its own modularity system called NgModules . NgModules are containers for a cohesive block of code dedicated to an application domain, a workflow, or a closely related set of capabilities. They can contain components, service providers, and other code files whose scope is defined by the containing NgModule. They can import functionality that is exported from other NgModules, and export selected functionality for use by other NgModules.

Every Angular application has at least one NgModule class, the root module , which is conventionally named AppModule and resides in a file named app.module.ts . You launch your application by bootstrapping the root NgModule.

While a small application might have only one NgModule, most applications have many more feature modules . The root NgModule for an application is so named because it can include child NgModules in a hierarchy of any depth.

NgModule metadata link

An NgModule is defined by a class decorated with @NgModule() . The @NgModule() decorator is a function that takes a single metadata object, whose properties describe the module. The most important properties are as follows.

Properties Details
declarations The components, directives , and pipes that belong to this NgModule.
exports The subset of declarations that should be visible and usable in the component templates of other NgModules.
imports Other modules whose exported classes are needed by component templates declared in this NgModule.
providers Creators of services that this NgModule contributes to the global collection of services; they become accessible in all parts of the application. (You can also specify providers at the component level.)
bootstrap The main application view, called the root component , which hosts all other application views. Only the root NgModule should set the bootstrap property.

Here's a simple root NgModule definition.

src/app/app.module.ts
      
      import { NgModule } from '@angular/core';
import { BrowserModule } from '@angular/platform-browser';
@NgModule({
  imports:      [ BrowserModule ],
  providers:    [ Logger ],
  declarations: [ AppComponent ],
  exports:      [ AppComponent ],
  bootstrap:    [ AppComponent ]
})
export class AppModule { }
    

AppComponent is included in the exports list here for illustration; it isn't actually necessary in this example. A root NgModule has no reason to export anything because other modules don't need to import the root NgModule.

NgModules and components link

NgModules provide a compilation context for their components. A root NgModule always has a root component that is created during bootstrap but any NgModule can include any number of additional components, which can be loaded through the router or created through the template. The components that belong to an NgModule share a compilation context.


A component and its template together define a view . A component can contain a view hierarchy , which allows you to define arbitrarily complex areas of the screen that can be created, modified, and destroyed as a unit. A view hierarchy can mix views defined in components that belong to different NgModules. This is often the case, especially for UI libraries.


When you create a component, it's associated directly with a single view, called the host view . The host view can be the root of a view hierarchy, which can contain embedded views , which are in turn the host views of other components. Those components can be in the same NgModule, or can be imported from other NgModules. Views in the tree can be nested to any depth.

NOTE :
The hierarchical structure of views is a key factor in the way Angular detects and responds to changes in the DOM and application data.

NgModules and JavaScript modules link

The NgModule system is different from, and unrelated to, the JavaScript (ES2015) module system for managing collections of JavaScript objects. These are complementary module systems that you can use together to write your applications.

In JavaScript each file is a module and all objects defined in the file belong to that module. The module declares some objects to be public by marking them with the export key word. Other JavaScript modules use import statements to access public objects from other modules.

      
      import { NgModule } from '@angular/core';
import { AppComponent } from './app.component';
    
      
      export class AppModule { }
    

Learn more about the JavaScript module system on the web.

Angular libraries link

Angular loads as a collection of JavaScript modules. You can think of them as library modules. Each Angular library name begins with the @angular prefix. Install them with the node package manager npm and import parts of them with JavaScript import statements.


For example, import Angular's Component decorator from the @angular/core library like this.

      
      import { Component } from '@angular/core';
    

You also import NgModules from Angular libraries using JavaScript import statements. For example, the following code imports the BrowserModule NgModule from the platform-browser library.

      
      import { BrowserModule } from '@angular/platform-browser';
    

In the example of the simple root module above, the application module needs material from within BrowserModule . To access that material, add it to the @NgModule metadata imports like this.

      
      imports:      [ BrowserModule ],
    

In this way, you're using the Angular and JavaScript module systems together . Although it's easy to confuse the two systems, which share the common vocabulary of "imports" and "exports", you will become familiar with the different contexts in which they are used.

Learn more from the NgModules guide.

Last reviewed on Mon Feb 28 2022
Read article

Angular - Next steps: tools and techniques

Next steps: tools and techniques link

After you understand the basic Angular building blocks, you can learn more about the features and tools that can help you develop and deliver Angular applications.

  • Work through the Tour of Heroes tutorial to get a feel for how to fit the basic building blocks together to create a well-designed application.
  • Check out the Glossary to understand Angular-specific terms and usage.
  • Use the documentation to learn about key features in more depth, according to your stage of development and areas of interest.

Application architecture link

  • The Main Concepts section located in the table of contents contains several topics that explain how to connect the application data in your components to your page-display templates, to create a complete interactive application.
  • The NgModules guide provides in-depth information on the modular structure of an Angular application.
  • The Routing and navigation guide provides in-depth information on how to construct applications that allow a user to navigate to different views within your single-page application.
  • The Dependency injection guide provides in-depth information on how to construct an application such that each component class can acquire the services and objects it needs to perform its function.

Responsive programming link

The template syntax and related topics contain details about how to display your component data when and where you want it within a view, and how to collect input from users that you can respond to.

Additional pages and sections describe some basic programming techniques for Angular applications.

  • Lifecycle hooks: Tap into key moments in the lifetime of a component, from its creation to its destruction, by implementing the lifecycle hook interfaces.
  • Observables and event processing: How to use observables with components and services to publish and subscribe to messages of any type, such as user-interaction events and asynchronous operation results.
  • Angular elements: How to package components as custom elements using Web Components, a web standard for defining new HTML elements in a framework-agnostic way.
  • Forms: Support complex data entry scenarios with HTML-based input validation.
  • Animations: Use Angular's animation library to animate component behavior without deep knowledge of animation techniques or CSS.

Client-server interaction link

Angular provides a framework for single-page applications, where most of the logic and data resides on the client. Most applications still need to access a server using the HttpClient to access and save data. For some platforms and applications, you might also want to use the PWA (Progressive Web App) model to improve the user experience.

  • HTTP: Communicate with a server to get data, save data, and invoke server-side actions with an HTTP client.
  • Server-side rendering: Angular Universal generates static application pages on the server through server-side rendering (SSR). This allows you to run your Angular application on the server in order to improve performance and show the first page quickly on mobile and low-powered devices, and also facilitate web crawlers.
  • Service workers and PWA: Use a service worker to reduce dependency on the network and significantly improve the user experience.
  • Web workers: Learn how to run CPU-intensive computations in a background thread.

Support for the development cycle link

  • CLI Command Reference: The Angular CLI is a command-line tool that you use to create projects, generate application and library code, and perform a variety of ongoing development tasks such as testing, bundling, and deployment.
  • Compilation: Angular provides just-in-time (JIT) compilation for the development environment, and ahead-of-time (AOT) compilation for the production environment.
  • Testing platform: Run unit tests on your application parts as they interact with the Angular framework.
  • Deployment: Learn techniques for deploying your Angular application to a remote server.
  • Security guidelines: Learn about Angular's built-in protections against common web-application vulnerabilities and attacks such as cross-site scripting attacks.
  • Internationalization: Make your application available in multiple languages with Angular's internationalization (i18n) tools.
  • Accessibility: Make your application accessible to all users.

File structure, configuration, and dependencies link

  • Workspace and file structure: Understand the structure of Angular workspace and project folders.
  • Building and serving: Learn to define different build and proxy server configurations for your project, such as development, staging, and production.
  • npm packages: The Angular Framework, Angular CLI, and components used by Angular applications are packaged as npm packages and distributed using the npm registry. The Angular CLI creates a default package.json file, which specifies a starter set of packages that work well together and jointly support many common application scenarios.
  • TypeScript configuration: TypeScript is the primary language for Angular application development.
  • Browser support: Make your applications compatible across a wide range of browsers.

Extending Angular link

  • Angular libraries: Learn about using and creating re-usable libraries.
  • Schematics: Learn about customizing and extending the CLI's generation capabilities.
  • CLI builders: Learn about customizing and extending the CLI's ability to apply tools to perform complex tasks, such as building and testing applications.
Last reviewed on Mon Feb 28 2022
Read article