function vs property in interface
Written byPhuoc Nguyen
Category
TypeScript
Created
18 Aug, 2020
There are two ways to define a method in an interface.
- Declare as a property whose type is function
interface Logger {
log: (message: string) => void;
}
- Declare as a normal function
interface Logger {
log(message: string): void;
}
#Differences
-
If the method is declared as a interface function, then it's possible for you to add more overload versions.interface Logger {log(message: string): void;}// In other placesinterface Logger {log(message: string, level: string): void;}Declaring method as a property, on the other hand, prevents you from duplicating the property declarations which have different types:interface Logger {log: (message: string) => void;}// Does not workinterface Logger {log: (message: string, level: string) => void;}
-
The
`readonly`
modifier only has effect with the property declaration.interface Person {firstName: string;lastName: string;readonly fullName: () => string;// Doesn't work// readonly fullName(): string;} -
TypeScript generates different output for a class that implements the interface methods.Assume that we have a class
`ConsoleLogger`
that simply logs the message in the Console window.For the first approach:interface Logger {log: (message: string) => void;}class ConsoleLogger implements Logger {log = (message: string) => {console.log(message);};}// Generated JavaScript code://// class ConsoleLogger {// constructor() {// this.log = (message) => {// console.log(message);// };// }// }For the second approach:interface Logger {log(message: string): void;}class ConsoleLogger implements Logger {log(message: string) {console.log(message);}}// Generated JavaScript code://// class ConsoleLogger {// log(message) {// console.log(message);// }// }Looking at the generated JavaScript codes, you'll see the different outputs.The first approach produces a property`log`
in the constructor. It means that`log`
will be created every time you create a new instance of class.While the second approach produces the`log`
method, and it exists in all instances of class. The`log`
method also is a member of class prototype, so we can extend the class to override the method if needed:class ConsoleLogger implements Logger {log(message: string) {console.log(message);}}class ConsoleLoggerWithColor extends ConsoleLogger {// Override the `log` methodlog(message: string) {// Display the message in white color and blue background areaconsole.log('%c%s', 'color: white; background: blue', message);}}See the differences between declaring methods in class constructor and prototype for more details.
Questions? 🙋
Do you have any questions? Not just about this specific post, but about any topic in front-end development that you'd like to learn more about? If so, feel free to send me a message on Twitter or send me an email. You can find them at the bottom of this page.
I have a long list of upcoming posts, but your questions or ideas for the next one will be my top priority. Let's learn together! Sharing knowledge is the best way to grow 🥷.
Recent posts ⚡
Copy the content of an element to your clipboard
01 Oct, 2023
Make a text area fit its content automatically
30 Sep, 2023
Quickly insert alternate characters while typing
30 Sep, 2023
Zebra-like background
30 Sep, 2023
Add autocomplete to your text area
28 Sep, 2023
Linear scale of a number between two ranges
28 Sep, 2023
Highlight the current line in a text area
27 Sep, 2023
Create your own custom cursor in a text area
27 Sep, 2023
Mirror a text area for improving user experience
26 Sep, 2023
Display the line numbers in a text area
24 Sep, 2023
Select a given line in a text area
24 Sep, 2023
Newsletter 🔔
If you're into front-end technologies and you want to see more of the content I'm creating, then you might want to consider subscribing to my newsletter.
By subscribing, you'll be the first to know about new articles, products, and exclusive promotions.
Don't worry, I won't spam you. And if you ever change your mind, you can unsubscribe at any time.
Phước Nguyễn