How to use paths in tsconfig.json?

by

This can be set up on your tsconfig.json file, as it is a TS feature.

You can do like this:

"compilerOptions": {
        "baseUrl": "src", // This must be specified if "paths" is.
         ...
        "paths": {
            "@app/*": ["app/*"],
            "@config/*": ["app/_config/*"],
            "@environment/*": ["environments/*"],
            "@shared/*": ["app/_shared/*"],
            "@helpers/*": ["helpers/*"]
        },
        ...

Have in mind that the path where you want to refer to, it takes your baseUrl as the base of the route you are pointing to and it’s mandatory as described on the doc.

The character ‘@’ is not mandatory.

After you set it up on that way, you can easily use it like this:

import { Yo } from '@config/index';

the only thing you might notice is that the intellisense does not work in the current latest version, so I would suggest to follow an index convention for importing/exporting files.

https://www.typescriptlang.org/docs/handbook/module-resolution.html#path-mapping

More Related Contents:

  1. Could not find a declaration file for module ‘module-name’. ‘/path/to/module-name.js’ implicitly has an ‘any’ type
  2. What is target in tsconfig.json for?
  3. Setting up tsconfig with spec/test folder
  4. How do I dynamically assign properties to an object in TypeScript?
  5. What is “not assignable to parameter of type never” error in TypeScript?
  6. How do I prevent the error “Index signature of object type implicitly has an ‘any’ type” when compiling typescript with noImplicitAny flag enabled?
  7. error TS2339: Property ‘x’ does not exist on type ‘Y’
  8. Get properties of a class
  9. Jest + Typescript + Absolute paths (baseUrl) gives error: Cannot find module
  10. How to remove index signature using mapped types
  11. typescript template literal as interface key
  12. TypeScript error TS1005: ‘;’ expected (II)
  13. Difference between extending and intersecting interfaces in TypeScript?
  14. How to do runtime type casting in TypeScript?
  15. Is there an option to make spreading an object strict?
  16. Circular Type References in TypeScript
  17. TypeScript: Why can’t I assign a valid field of an object with type { a: “a”, b: “b” }
  18. TypeScript keyof returning specific type
  19. Generating typescript declaration files from javascript
  20. ts An async function or method in ES5/ES3 requires the ‘Promise’ constructor
  21. How to declare a function that throws an error in Typescript
  22. How to use enum as index key type in typescript?
  23. How to share code between TypeScript projects?
  24. How to make Typescript infer the keys of an object but define type of its value?
  25. Is there ArgumentsType like ReturnType in Typescript?
  26. Typescript: Remove entries from tuple type
  27. Check if object correctly implements interface
  28. Is it possible to narrow the types of overloaded parameters without exhaustively checking each parameter in the function body?
  29. What are the differences between the private keyword and private fields in TypeScript?
  30. TypeScript: deep partial?

Leave a Comment