TypeScript Import Path Alias

by

So after reading your comment, I realized I misunderstood your question! If you want to control the paths from an imported package’s perspective, just use set the main property of your package.json to a file that properly represents the object graph of your module.

{
  "main": "common-utils/dist/es2015/index.js"
}

If you’re attempting to control the import paths from a project’s perspective, what you’re looking for is TypeScript 2’s new path mapping feature for module resolution. You can enable path mapping by configuring your tsconfig.json as follows:

{
  "compilerOptions": {
    "baseUrl": ".",
    "paths": {
      "angular2/*": ["../path/to/angular2/*"],
      "local/*": ["../path/to/local/modules/*"]
    }
  }
}

Then, in your TypeScript files, you can import the modules like this:

import { bootstrap } from 'angular2/bootstrap';
import { module } from 'local/module';

For more details about the Path Mapping feature in TypeScript 2 see this Github issue.

In your case, I think the following configuration should work:

{
  "compilerOptions": {
    "baseUrl": ".",
    "paths": {
      "common-utils/utils/*": ["./node_modules/common-utils/dist/es2015/utils/*"]
    }
  }
}

More Related Contents:

  1. What is the Record type in typescript?
  2. How to exclude getter only properties from type in typescript
  3. Purpose of declare keyword in TypeScript
  4. How to configure custom global interfaces (.d.ts files) for TypeScript?
  5. Typescript 2.0. “types” field in tsconfig.json
  6. ‘this’ implicitly has type ‘any’ because it does not have a type annotation
  7. What is the Record type?
  8. How to prevent “Property ‘…’ does not exist on type ‘Global'” with jsdom and typescript?
  9. How to add custom “typings” in typescript 2.0 / 3.0
  10. Property is not assignable to string index in interface [duplicate]
  11. Operator ‘==’ cannot be applied to types x and y in Typescript 2
  12. Interfaces vs Types in TypeScript
  13. Why does A | B allow a combination of both, and how can I prevent it?
  14. How to return value from function which has Observable subscription inside?
  15. Typescript Discriminated Union allows invalid state
  16. Why can’t I return a generic ‘T’ to satisfy a Partial?
  17. Parameters generic of overloaded function doesn’t contain all options
  18. Enforcing the type of the indexed members of a Typescript object?
  19. Constructor overload in TypeScript
  20. Disallow call with any
  21. Typescript overload arrow functions
  22. How to get a subset of `keyof T` whose value, T[K] are callable functions in Typescript
  23. How do I find an array item with TypeScript? (a modern, easier way)
  24. Angular 2 2.0.0-rc.1 Property ‘map’ does not exist on type ‘Observable’ not the same as issue report
  25. ES7 Object.entries() in TypeScript not working
  26. ‘Property does not exist on type ‘never’
  27. Typescript type T or function () => T usage
  28. Typescript and filter Boolean
  29. Angular2 – root relative imports
  30. A way to mark arbitrary strings in Typescript Template Literals

Leave a Comment