Check if an object implements an interface at runtime with TypeScript

by

There “is” a way, but you have to implement it yourself. It’s called a “User Defined Type Guard” and it looks like this:

interface Test {
    prop: number;
}

function isTest(arg: any): arg is Test {
    return arg && arg.prop && typeof(arg.prop) == 'number';
}

Of course, the actual implementation of the isTest function is totally up to you, but the good part is that it’s an actual function, which means it’s testable.

Now at runtime you would use isTest() to validate if an object respects an interface. At compile time typescript picks up on the guard and treats subsequent usage as expected, i.e.:

let a:any = { prop: 5 };

a.x; //ok because here a is of type any

if (isTest(a)) {
    a.x; //error because here a is of type Test
}

More in-depth explanations here: https://basarat.gitbook.io/typescript/type-system/typeguard

More Related Contents:

  1. Function that takes an input between 0 and 5 and outputs an array of 5 elements that will be used for generating 5 stars in the UI [closed]
  2. Can’t perform a React state update on an unmounted component
  3. Angular 2 Sibling Component Communication
  4. How to convert an array of objects to object with key value pairs
  5. JS : Convert Array of Strings to Array of Objects
  6. Angular 4.3.3 HttpClient : How get value from the header of a response?
  7. How to reduce javascript object to only contain properties from interface
  8. In Angular, how do you determine the active route?
  9. Throttle amount of promises open at a given time
  10. ‘package.json’ is not under ‘rootDir’
  11. Typescript – Extending Error class
  12. What’s the difference between “declare class” and “interface” in TypeScript
  13. VueJS/Typescript – Cannot find module ‘./components/Navigation’ or its corresponding type declarations
  14. Error: ‘types’ can only be used in a .ts file – Visual Studio Code using @ts-check
  15. Call a function on click event in Angular 2
  16. Optional chaining on the left side in Javascript
  17. How to make TypeScript output valid ES6 module import statements?
  18. Visual Studio Code Syntax Highlighting not working for Javascript and Typescript [closed]
  19. How to Pass data from child to parent component Angular
  20. Angular2 too many file requests on load
  21. Should we use useCallback in every function handler in React Functional Components
  22. Server Discovery And Monitoring engine is deprecated
  23. Generate dynamic css based on variables angular
  24. Why I am not getting warnings about StrictNullChecks in typescript
  25. Plain Javascript as Angular 2 service
  26. TypeScript TS7015: Element implicitly has an ‘any’ type because index expression is not of type ‘number’
  27. binding data to angular checkbox
  28. Determine if a CSS class exists with Javascript
  29. How to prevent Next.js from instantiating a singleton class/object multiple times?
  30. Declare an array in TypeScript

Leave a Comment