TypeScript function overloading

by

When you overload in TypeScript, you only have one implementation with multiple signatures. 

class Foo {
    myMethod(a: string);
    myMethod(a: number);
    myMethod(a: number, b: string);
    myMethod(a: any, b?: string) {
        alert(a.toString());
    }
}

Only the three overloads are recognized by TypeScript as possible signatures for a method call, not the actual implementation.

In your case, I would personally use two methods with different names as there isn’t enough commonality in the parameters, which makes it likely the method body will need to have lots of “ifs” to decide what to do.

TypeScript 1.4

As of TypeScript 1.4, you can typically remove the need for an overload using a union type. The above example can be better expressed using:

myMethod(a: string | number, b?: string) {
    alert(a.toString());
}

The type of a is “either string or number“.

More Related Contents:

  1. Constructor overload in TypeScript
  2. Typescript overload arrow functions
  3. Is it possible to narrow the types of overloaded parameters without exhaustively checking each parameter in the function body?
  4. TypeScript: Object.keys return string[]
  5. Angular 2 custom form input
  6. What is the syntax for Typescript arrow functions with generics?
  7. How to extend String Prototype and use it next, in Typescript?
  8. Types in object destructuring
  9. How to prepare release version with SystemJS and Gulp?
  10. How to declare a Fixed length Array in TypeScript
  11. Is it possible to restrict number to a certain range
  12. Higher-order type functions in TypeScript?
  13. Angular 6 View is not updated after changing a variable within subscribe
  14. ESLint – Configuring “no-unused-vars” for TypeScript
  15. Object destructuring with property names that are not valid variable names
  16. How to install Typescript typings for google maps
  17. How to use Object.values with typescript?
  18. is there a way to get all required properties of a typescript object
  19. What’s the meaning of “=>” in TypeScript? (Fat Arrow)
  20. How to use array.map with tuples in typescript?
  21. Typescript and spread operator?
  22. Angular 2 ngModel in child component updates parent component property
  23. Getting the return type of a function which uses generics
  24. Angular 2 loader on each http request
  25. Typescript: type narrowing not working for `in` when key is stored in a variable
  26. Run factory function on import in TypeScript?
  27. How do I decide whether @types/* goes into `dependencies` or `devDependencies`?
  28. Self-referencing return type for static methods in inheriting classes
  29. Types from both keys and values of object in Typescript
  30. How to place a dynamic component in a container

Leave a Comment