Skip to main content

The Magic of Angular Pipes

 the magic of angular pipes

Pipe is an object that interlinks two different points, and delivers an output in a desired manner.

Similarly in Angular, Pipes consume an input value and emits a possibly desired output (formatting the input) as a result.

I pretty much had a bad practice of using functions within the angular templates in order to fetch details or resolving values. And it took me a while to understand that using functions in the templates are bad for performance.

Then I started leveraging the power of a weapon that angular provides us to transform values.

We have many a predefined set of pipes that angular provides and it is indeed very easy to build a custom pipe to format your result set.

For any formatted output, we tend to write functions in the templates in order to compute any value.

Always remember that using functions in the templates are bad for performance. Instead use Pipes for smoother code execution.

Here I write down how to build your custom pipes easily and leverage their use.

Custom pipe to work with JSON values

Custom pipe to work with conditional values (emit different values in different scenarios)

Pipe for JSON value

Say your JSON string value is as below:

{

"destination":"London",

"destinationCode":"LON",

"source":"California",

"sourceCode": "CA"

}

Now in a case where you need to extract a value of a specific key in your template.

Custom pipe

import { Pipe, PipeTransform } from '@angular/core';


@Pipe({

  name: 'travelDetails'

})

export class TravelDetailsPipe implements PipeTransform {


  transform(travelDetailsJson: string, ...args: any[]): any {

    return this.getValueFromJson(travelDetailsJson, args[0]);

  }


  // compute the json of travelDetailsJson and get the value of the key

  getValueFromJson(travelDetailsJson, key) {

    return Object.keys(travelDetailsJson).length > 0 ? JSON.parse(travelDetailsJson)[key] : '';

  }

}

Usage in the template

<span>

{{ travelDetailsJson | travelDetails: 'source' }}

</span>

In the above code your pass the JSON string and the necessary key to extract the value and that’s it you have a clean and clear way of writing custom pipes.

Bad Practice of using functions in template (AVOID DOING THIS)

<span>

{{ getSourceDetails(travelDetailsJson) }}

</span>

Where in the above code piece, the function getSourceDetails(param) computes the necessary values and returns it.

Pipe for conditional value

Say when using mat-tab component and the tab has to show different labels for users depending on the persona (roles).

Custom pipe

import { Pipe, PipeTransform } from '@angular/core';


@Pipe({

  name: 'userTabName'

})

export class UserTabNamePipe implements PipeTransform {


  transform(tab: string, ...args: any[]): string {

    return this.getTabLabel(tab, args[0]);

  }


  getTabLabel(tab: string, isAdmin: boolean): string {

    let tabName = '';

      switch (tab) {

        case 'New':

          tabName = isAdmin ? 'New Requests' :  'My Requests';

          break;

        case 'InProgress':

          tabName = isAdmin ? 'Accepted' : 'In Progress';

          break;

        case 'Review':

          tabName = isAdmin ? 'Review' : 'In Review';

          break;

      }

      return tabName;

  }

}

Usage in the template

<mat-tab label="{{ 'New' | userTabName: isAdmin }}">

The parameters to the custom pipe can be increased as necessary in the template like below.

<mat-tab label="{{ 'New' | userTabName: isAdmin:isReadonly }}">

Here in the above case, the custom pipe takes an additional attribute for isReadonly (args[1]) in along with isAdmin (args[0]).

Second parameter in the transform method i.e., …args: any[] takes any number of arguments coming from the template. They needs to be used as args[0], args[1].. etc. for any computation.

The above mentioned are two of the custom pipes that you can use and transform into any other custom pipes to build and use.

Happy Coding..!!

Comments

Post a Comment

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...
Post a Comment
Read more

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 ...
Post a Comment
Read more

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...
Post a Comment
Read more