TypeScript importing module path

Question

I have the following file:

myProjectRoot/src/server.ts

Inside this it has:

import testRouter from 'module/lib';

I have a library which exports a default value at:

myProjectRoot/src/module/lib.ts

My myProjectRoot/tsconfig.json file:

{
    "compilerOptions": {
        "module": "commonjs",
        "target": "es6",
        "lib": [
            "es6"
        ],
        "sourceMap": true,
        "baseUrl": "./src/"
    },
    "exclude": [
        "node_modules"
    ]
}

I get the error: [ERROR] 15:50:42 Error: Cannot find module 'module/lib'

I think you can just put src/ if the tsconfig is on the root already — Mike Tung
– Mike Tung, Commented May 8, 2019 at 13:59
@Paleo I was looking for this. I have seen it work using paths — Ruan Mendes
– Ruan Mendes, Commented May 8, 2019 at 15:00

Ruby Tunaley · Accepted Answer · 2019-05-10 03:15:09Z

You have two options here.

Use Relative Imports

This is the simplest option. Just specify relative paths when importing stuff.

import testRouter from './module/lib';

Set Up Import Aliases

You can edit your tsconfig.json so that it resolves the path you typed.

{
    "compilerOptions": {
        "baseUrl": "./src/",
        "paths": {
            "./*": ["./src/*"]
        }
    }
}

As we can see, TypeScript will now resolve the import properly.

BEWARE: The above just tells the TypeScript compiler that paths can be resolved from src, but does not affect code emit. For example, the import statement still gets compiled to the following:

const lib_1 = require("module/lib");

This means that unless you have another build tool which can transform that require into a relative path, the import will not work at runtime even though TypeScript says it's okay.

Collectives™ on Stack Overflow

TypeScript importing module path

1 Answer 1

Use Relative Imports

Set Up Import Aliases

Comments

Your Answer

Hot Network Questions

Collectives™ on Stack Overflow

1 Answer 1

Use Relative Imports

Set Up Import Aliases

Comments

Your Answer

Sign up or log in

Post as a guest

Related