JavaScript decorators from scratch

We invite future students of the course "JavaScript Developer. Professional" to sign up for an open lesson on the topic "Making an interactive telegram bot on Node.js" .



And now we are sharing the traditional translation of useful material.






Understanding decorator functions

What is a decorator?

A decorator is a facility that allows you to wrap one function in another and extend its capabilities. You "decorate" existing code by wrapping it in other code. This trick is familiar to anyone familiar with function composition or higher-order functions.





Decorators are not new. They are used in other languages โ€‹โ€‹as well, such as Python, and even functional programming in JavaScript. But we'll talk about this later.





Why do we need decorators?

They allow you to write cleaner code, adhere to the concept of composition, and extend a once developed feature to multiple functions and classes. By using decorators, you can write code that is easier to debug and maintain.





, , , . , .





2- , .





. Bit (Github). .





, .





Bit  Node, TypeScript, React, Vue, Angular JS.





Examples of reusable React components on Bit.dev
React- Bit.dev

?

 โ€” . , -. -, . , .





?

.





 โ€” . , Java, , , . JavaScript , . , .





, . , , , .





, , .





//decorator function
const allArgsValid = function(fn) {
  return function(...args) {
  if (args.length != fn.length) {
      throw new Error('Only submit required number of params');
    }
    const validArgs = args.filter(arg => Number.isInteger(arg));
    if (validArgs.length < fn.length) {
      throw new TypeError('Argument cannot be a non-integer');
    }
    return fn(...args);
  }
}

//ordinary multiply function
let multiply = function(a,b){
	return a*b;
}

//decorated multiply function that only accepts the required number of params and only integers
multiply = allArgsValid(multiply);

multiply(6, 8);
//48

multiply(6, 8, 7);
//Error: Only submit required number of params

multiply(3, null);
//TypeError: Argument cannot be a non-integer

multiply('',4);
//TypeError: Argument cannot be a non-integer
      
      



- allArgsValid



, . , -. - , . . : , .





multiply



, . - allArgsValid



, , , . multiply



. , .





//ordinary add function
let add = function(a,b){
	return a+b;
}

//decorated add function that only accepts the required number of params and only integers
add = allArgsValid(add);

add(6, 8);
//14

add(3, null);
//TypeError: Argument cannot be a non-integer

add('',4);
//TypeError: Argument cannot be a non-integer
      
      



: , TC39

JavaScript . 2- .





JavaScript โ€” .  โ€” , .





,  โ€” . ? .





, .





function log(fn) {
  return function() {
    console.log("Execution of " + fn.name);
    console.time("fn");
    let val = fn();
    console.timeEnd("fn");
    return val;
  }
}

class Book {
  constructor(name, ISBN) {
    this.name = name;
    this.ISBN = ISBN;
  }

  getBook() {
    return `[${this.name}][${this.ISBN}]`;
  }
}

let obj = new Book("HP", "1245-533552");
let getBook = log(obj.getBook);
console.log(getBook());
//TypeError: Cannot read property 'name' of undefined
      
      



, getBook



, - log



. obj.getBook



. this



, Book



. TypeError



.





, Book



getBook



.





function log(classObj, fn) {
  return function() {
    console.log("Execution of " + fn.name);
    console.time("fn");
    let val = fn.call(classObj);
    console.timeEnd("fn");
    return val;
  }
}

class Book {
  constructor(name, ISBN) {
    this.name = name;
    this.ISBN = ISBN;
  }

  getBook() {
    return `[${this.name}][${this.ISBN}]`;
  }
}

let obj = new Book("HP", "1245-533552");
let getBook = log(obj, obj.getBook);
console.log(getBook());
//[HP][1245-533552]
      
      



Book



- log



, obj.getBook



, this



.





, . , .





. Babel. JSFiddle



 โ€” , . , : .





@. - log



:





@log
      
      



- . - , . target



, .





target



, . , . .





, Book



, .





function log(target) {
  return function(...args) {
    console.log("Constructor called");
    return new target(...args);
  };
}

@log
class Book {
  constructor(name, ISBN) {
    this.name = name;
    this.ISBN = ISBN;
  }

  getBook() {
    return `[${this.name}][${this.ISBN}]`;
  }
}

let obj = new Book("HP", "1245-533552");
//Constructor Called
console.log(obj.getBook());
//HP][1245-533552]
      
      



, log



  target



  . log



, target



, Book



. target



target.prototype.property.







, -, :





function logWithParams(...params) {
  return function(target) {
    return function(...args) {
      console.table(params);
      return new target(...args);
    }
  }
}

@log
@logWithParams('param1', 'param2')
class Book {
	//Class implementation as before
}

let obj = new Book("HP", "1245-533552");
//Constructor called
//Params will be consoled as a table
console.log(obj.getBook());
//[HP][1245-533552]
      
      



, , @



. , , .





, , . , :





  • target



     โ€” , , ;





  • name



     โ€” , ;





  • descriptor



     โ€” , , .   .





descriptor. 4 :





  • configurable



     โ€” , , ;





  • enumerable



     โ€” , , ;





  • value



     โ€” . ;





  • writable



     โ€” , , .





Book



.





//readonly decorator function
function readOnly(target, name, descriptor) {
  descriptor.writable = false;
  return descriptor;
}

class Book {
  //Implementation here
  @readOnly
  getBook() {
    return `[${this.name}][${this.ISBN}]`;
  }

}

let obj = new Book("HP", "1245-533552");

obj.getBook = "Hello";

console.log(obj.getBook());
//[HP][1245-533552]
      
      



- readOnly



, getBook



Book



  . writable



false



. true



.





writable



, getBook



, , :





obj.getBook = "Hello";
console.log(obj.getBook);
//Hello
      
      



. TypeScript , JavaScript 3- .





-, , , . . , value



. initializer



. , initializer



. initializer



.





(undefined



), writable



.





. Book



.





function upperCase(target, name, descriptor) {
  if (descriptor.initializer && descriptor.initializer()) {
    let val = descriptor.initializer();
    descriptor.initializer = function() {
      return val.toUpperCase();
    }
  }

}

class Book {
  
  @upperCase
  id = "az092b";

  getId() {
    return `${this.id}`;
  }

  //other implementation here
}

let obj = new Book("HP", "1245-533552");

console.log(obj.getId());
//AZ092B
      
      



id . - upperCase



initializer



, , (  undefined



). , ยซ ยป (. .: . truthy โ€” , true



Boolean



), . getId



. , .





. , .





Angular

TypeScript Angular, Angular, @Component



, @NgModule



, @Injectable



, @Pipe



. . .





MobX

MobX 6- . @observable



, @computed



@action



. MobX , . :





ยซ ES, . , ยป.





Core Decorators

JavaScript, . 0, , 3- .





, @readonly



, @time



, @deprecate



. .





Redux React

Redux React connect



, React Redux. connect



  .





//Before decorator
class MyApp extends React.Component {
  // ...define your main app here
}
export default connect(mapStateToProps, mapDispatchToProps)(MyApp);
//After decorator
@connect(mapStateToProps, mapDispatchToProps)
export default class MyApp extends React.Component {
  // ...define your main app here
}
      
      



Felix Kling Stack Overflow .





connect



  , Redux . , 2- , , .





 โ€” , . .





, , !






"JavaScript Developer. Professional".



" telegram Node.js".












All Articles