Skip to main content

APP_INITIALIZER in Angular



APP_INITIALIZER in Angular

What is an APP_INITIALIZER?

The APP_INITIALIZER is a built in injection token available in angular. The purpose of APP_INITIALIZER is to perform any initialization task when the application loads. Mostly the APP_INITIALIZER will be used to get the application's configuration details before the application is rendered by called the api. The best way to use it is by returning a promise function, so that it will wait until any operation is done and the promise is resolved. Once the promise is resolved, then the application will be initialized.

Let's see it with an example program.

Create a new angular application using angular cli command.

ng new angular-tutorial

Create a service to hold the configuration details. Lets create the service in the services folder by the following angular cli command.

ng g s services/config

Open the config.service.ts file and modify the code as below.

We have created a variable config which will be holding the property serverUrl. We have a function init to set the serverUrl property and once the property has been set, then it will log 'Configuration has been set.' to the console.

We also have another function, getConfig to return the configuration in the config variable.

Open the app.module.ts file and modify the code as below.

In the above code we have imported the APP_INITIALIZER and the ConfigService.

In order to use the APP_INITIALIZER, we have to use the syntax as below.

{ provide: APP_INITIALIZER, useFactory: function, deps: [], multi: true/false }

We have to supply the APP_INITIALIZER as the value to the provide property. For useFactory property we will be supplying function as its value. The function can perform synchronous or asynchronous function. The depsproperty is an array that will hold the dependencies needed for the function and the multi parameter can be true or false. By default it is false. If it is set to false then we use a token more than once, the last to register will override all the previous tokens. i.e you can have only one provider for token. If it is true, then the new providers are added to the previously registered providers making it more than one provider for a token. The angular will execute all of them when the token in invoked.

In our code, we have provided intializeConfig function as the value to useFactory parameter and provided ConfigService and HttpClient as the dependencies in deps array and set the multi parameter to be 'true'.

Now lets take a look at the initializeConfig function

The initializeConfig function takes ConfigService and HttpClient as parameter in configService and http variable name respectively. This function is going to return a function as result and that function is going to return a Promise. Inside the function we make api call using http variable and chain it to return it as promise using toPromise. Once it makes the api call now it returns a promise. To retrieve the value from it we use thenfunction and get the result from it. Then we set a url in it by calling the initfunction available in ConfigService using configService variable and return a resolve with a 'Success' string message.

Now, open the app.component.ts file and inside its constructor add some console to verify that the APP_INITIALIZER has been loaded initially.

Now run your application using

ng serve --o

Press F12 and check out the console. It will make the api to log the result to the console. It displays logs as below

Configuration has been set.

App component loaded

This is the way we have to use the APP_INITIALIZER.



Comments

Popular posts from this blog

4 Ways to Communicate Across Browser Tabs in Realtime

1. Local Storage Events You might have already used LocalStorage, which is accessible across Tabs within the same application origin. But do you know that it also supports events? You can use this feature to communicate across Browser Tabs, where other Tabs will receive the event once the storage is updated. For example, let’s say in one Tab, we execute the following JavaScript code. window.localStorage.setItem("loggedIn", "true"); The other Tabs which listen to the event will receive it, as shown below. window.addEventListener('storage', (event) => { if (event.storageArea != localStorage) return; if (event.key === 'loggedIn') { // Do something with event.newValue } }); 2. Broadcast Channel API The Broadcast Channel API allows communication between Tabs, Windows, Frames, Iframes, and  Web Workers . One Tab can create and post to a channel as follows. const channel = new BroadcastChannel('app-data'); channel.postMessage(data); And oth...

Certbot SSL configuration in ubuntu

  Introduction Let’s Encrypt is a Certificate Authority (CA) that provides an easy way to obtain and install free  TLS/SSL certificates , thereby enabling encrypted HTTPS on web servers. It simplifies the process by providing a software client, Certbot, that attempts to automate most (if not all) of the required steps. Currently, the entire process of obtaining and installing a certificate is fully automated on both Apache and Nginx. In this tutorial, you will use Certbot to obtain a free SSL certificate for Apache on Ubuntu 18.04 and set up your certificate to renew automatically. This tutorial will use a separate Apache virtual host file instead of the default configuration file.  We recommend  creating new Apache virtual host files for each domain because it helps to avoid common mistakes and maintains the default files as a fallback configuration. Prerequisites To follow this tutorial, you will need: One Ubuntu 18.04 server set up by following this  initial ...

Working with Node.js streams

  Introduction Streams are one of the major features that most Node.js applications rely on, especially when handling HTTP requests, reading/writing files, and making socket communications. Streams are very predictable since we can always expect data, error, and end events when using streams. This article will teach Node developers how to use streams to efficiently handle large amounts of data. This is a typical real-world challenge faced by Node developers when they have to deal with a large data source, and it may not be feasible to process this data all at once. This article will cover the following topics: Types of streams When to adopt Node.js streams Batching Composing streams in Node.js Transforming data with transform streams Piping streams Error handling Node.js streams Types of streams The following are four main types of streams in Node.js: Readable streams: The readable stream is responsible for reading data from a source file Writable streams: The writable stream is re...