Search code examples
node.jstypescriptnpmtsc

How to consume npm modules from typescript?

I'm giving a shot at typescript. It works fine at the hello world stage. I'm now trying to use a npm module :

index.ts =

import _ = require('lodash')

console.log(_.toUpper('Hello, world !'))

This doesn't work :

  • tsc index.ts -> Cannot find module 'lodash'. (2307)
  • node-ts index.js -> Cannot find module 'lodash'. (2307)

Looking at typescript documentation and in google didn't help. Other S/O questions are either unanswered (here and here) or unrelated.

Elements :

  • typescript 1.8 latest
  • Yes, lodash is installed npm i --save lodash and exists in my filesystem (checked)
  • I also did typings i --save lodash
  • variants import * as _ from 'lodash' or const _ = require('lodash') don't work either
  • I tried tweaking tsconfig.json options as suggested in other answers "moduleResolution": "node" and "module": "commonjs" as suggested in some answers, still doesn't work

How do we consume a npm package in typescript ??

Solution

  • [2018/12] New, up-to-date, answer to this question I asked in 2016, which stills shows a lot of activity despite having outdated answers.

    Long story short, TypeScript requires type informations about your package's code (a.k.a. "type declaration files" a.k.a. "typings") and rightfully tells you that you would otherwise be losing the whole point of TypeScript. There are several solutions to provide them or opt out of them, listed here in order of best practice:

    Solution 0: the module already provides the typings. If its package.json contains a line like this:

    "typings": "dist/index.d.ts",

    it is already TypeScript-enabled. It's most likely not the case if you are reading this page, so let's continue...

    Solution 1: use community-contributed typings from DefinitelyTyped. For a module "foo", try this:

    npm add -D @types/foo

    if it works, jackpot! You now have the typings and can use your module. If npm complains that it can't find the module @types/foo, let's continue...

    Solution 2: provide custom typings about this module. (with an option to do zero effort)

    1. Create a folder named "typings-custom" at the root of your project
    2. Reference the content of this folder in your tsconfig.json:
    "include": [
    "./typings-custom/**/*.ts"
]
    1. Create a file with this exact name: foo.d.ts [foo = the name of the module] with the content:
    declare module 'foo'

    Your TypeScript code should now compile, albeit with NO type information (TypeScript consider the foo module of type "any").

    You can also attempt to write the type information yourself, looking at the official doc and/or at examples from DefinitelyTyped. If you do, think of contributing your typings either directly into the module (solution 0, if the module author accepts) or into DefinitelyTyped (solution 1)