Skip to main content

Utilizing Decorators in Typescript

Decorator is a quite good feature in Typescript even though it is currently still in an experimental state. But, because of its advantages, it is commonly used by any developer. Such a framework like Angular also heavily uses this feature from the beginning.

A decorator is a syntax for calling a function on the thing that it is decorated. It acts like a wrapper function or higher-order function that results in an improved thing or thing with additional things. The thing may be a class, class method, class property, or method property. The thing that will be decorated must have a specific type signature. A class decorator can only decorate a class, an object that has a constructor.

@mydecorator
class MyClass {}

The code above is similar to the following code.

class MyClass {}
const WrappedClass = mydecorator(MyClass);

We will take the example of utilizing a class decorator. First, we need to create a type of class constructor that passes a generic type for defining the shape of the class instance. The type can be generated by the new operator which is applied to a function that returns a generic type value.

type Constructor<T> = new (...args: any[]) => T;

Then, we set up our decorator by creating a function that accepts a class with a valid type as the first parameter. A valid type means that it extends the class constructor. Besides that, it should have specific properties or methods that can define the shape of the specified class instance. For example, the class will have the getValue() method that results in an object.

function withJson<T extends Constructor<{
  getValue: () => { point: number }
}>>(Class: T) {
  return class extends Class {
    getJson = () => {
      return JSON.stringify(this.getValue());
    }
  }
}

We can apply the function as a decorator for a class that aligns with the class constructor or in other words, it implements getValue() method.

@withJson
class MyClass {
    value = { point: 10 };
    getValue() {
    	return this.value;
    }
}

Then, we can create an instance of the class and call the getJson() method.

const myObject = new MyClass();
console.log(myObject.getJson());

But, Typescript will show an error by the previous code. It is because the decorator won't change the shape or type structure that will be interpreted by Typescript. The getJson() method won't be recognized as the valid property of the class instance. There are several solutions for this case. But, what more appropriate is by declaring a class which is defining the method as property and extending the declared class to the decorated class.

class Helper {
    getJson: any;
}

@withJson
class MyClass extends Helper {
    value = { point: 10 };
    getValue() {
    	return this.value;
    }
}

Last, how it is if we want to create a factory of a decorator that accepts any parameters for defining the resulting decorator. We can customize the withJson() method into a factory. As an example, we will create a factory that accepts a parameter as an additional value for the point property in the instance value.

const withJson = (additionalValue: number) => {
  return <T extends Constructor<{
    getValue: () => { point: number }
  }>>(Class: T) => {
    return class extends Class {
      getJson = () => {
        return JSON.stringify({ point: this.getValue().point + additionalValue});
      }
    }
  };
}

@withJson(5)
class MyClass extends Helper {
//...
}

const myObject = new MyClass();
console.log(myObject.getJson());

So, if the code above is run, it will result in { "point": 15 }.


Comments

Popular posts from this blog

Setting Up Next.js Project With ESLint, Typescript, and AirBnB Configuration

If we initiate a Next.js project using the  create-next-app tool, our project will be included with ESLint configuration that we can apply using yarn run lint . By default, the tool installs eslint-config-next and extends next/core-web-vitals in the ESLint configuration. The Next.js configuration has been integrated with linting rules for React and several other libraries and tools. yarn create next-app --typescript For additional configuration such as AirBnB, it is also possible. First, we need to install the peer dependencies of eslint-config-airbnb . We also add support for Typescript using eslint-config-airbnb-typescript . yarn add --dev eslint-config-airbnb eslint-plugin-import eslint-plugin-jsx-a11y eslint-plugin-react eslint-plugin-react-hooks yarn add --dev eslint-config-airbnb-typescript @typescript-eslint/eslint-plugin @typescript-eslint/parser After that, we can update the .eslintrc.json file for the new configuration. { "extends": [ "airb

Rangkaian Sensor Infrared dengan Photo Dioda

Keunggulan photodioda dibandingkan LDR adalah photodioda lebih tidak rentan terhadap noise karena hanya menerima sinar infrared, sedangkan LDR menerima seluruh cahaya yang ada termasuk infrared. Rangkaian yang akan kita gunakan adalah seperti gambar di bawah ini. Pada saat intensitas Infrared yang diterima Photodiode besar maka tahanan Photodiode menjadi kecil, sedangkan jika intensitas Infrared yang diterima Photodiode kecil maka tahanan yang dimiliki photodiode besar. Jika  tahanan photodiode kecil  maka tegangan  V- akan kecil . Misal tahanan photodiode mengecil menjadi 10kOhm. Maka dengan teorema pembagi tegangan: V- = Rrx/(Rrx + R2) x Vcc V- = 10 / (10+10) x Vcc V- = (1/2) x 5 Volt V- = 2.5 Volt Sedangkan jika  tahanan photodiode besar  maka tegangan  V- akan besar  (mendekati nilai Vcc). Misal tahanan photodiode menjadi 150kOhm. Maka dengan teorema pembagi tegangan: V- = Rrx/(Rrx + R2) x Vcc V- = 150 / (150+10) x Vcc V- = (150/160) x 5

Itachi Uchiha

The Real Hero of Konoha

How To Use Git in Netbeans

Git is a popular version control application nowadays. Recently I have created a note about its differences with SVN and how to use it in Eclipse . There are many Git client tools. But I just want to show how to use Netbeans built-in Git tools. It makes the development process easier because it has been integrated with the IDE. Create Remote Git Repository We need a remote Git repository so everyone can store or receive any revision or updated files through the networks. We can set up our own Git server or use a public Git server like Github . In this note, I use Github. 1. Create an account in Github and create an empty Git repository Create an empty public repository in Github 2. Get the remote repository link Your Github Repository URL Create a New Project in Netbeans and Create Local Git Repository After we have a remote Git repository, we can create a project stored in the remote repository. We also need to create a local repository before we can push

Raspberry Pi Bluetooth Connection

Raspberry Pi 3 provides a built-in Bluetooth module. The latest Raspbian has been bundled with tools for enabling Bluetooth connection. The Bluetooth icon will be shown up on the top right corner of the desktop. It's a tool to discover available Bluetooth devices and connect Pi with Bluetooth devices. It is easy to connect any Bluetooth-enabled electronic device with Pi. But, sometimes Pi will fail to connect, especially for Bluetooth device that has no standardized services. From a terminal, we can use the  bluetoothctl tool to scan and connect with a Bluetooth device. You should make sure that the BlueZ protocol stack has been installed by running $ apt-get install bluez Run bluetoothctl to enter the tool command window Turn the power on by running power on (Optional) You can set AutoEnable=true in /etc/bluetooth/main.conf if you want to make the Bluetooth auto power-on after reboot. Run devices to see which devices have been paired Run scan on if your desired d

Configuring Swap Memory on Ubuntu Using Ansible

If we maintain a Linux machine with a low memory capacity while we are required to run an application with high memory consumption, enabling swap memory is an option. Ansible can be utilized as a helper tool to automate the creation of swap memory. A swap file can be allocated in the available storage of the machine. The swap file then can be assigned as a swap memory. Firstly, we should prepare the inventory file. The following snippet is an example, you must provide your own configuration. [server] 192.168.1.2 [server:vars] ansible_user=root ansible_ssh_private_key_file=~/.ssh/id_rsa Secondly, we need to prepare the task file that contains not only the tasks but also some variables and connection information. For instance, we set /swapfile  as the name of our swap file. We also set the swap memory size to 2GB and the swappiness level to 60. - hosts: server become: true vars: swap_vars: size: 2G swappiness: 60 For simplicity, we only check the exi