How to consume npm modules from typescript?

by

[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)

More Related Contents:

  1. Can’t run my Node.js Typescript project TypeError [ERR_UNKNOWN_FILE_EXTENSION]: Unknown file extension “.ts” for /app/src/App.ts
  2. Module not found: Error can’t resolve ‘child_process’, how to fix?
  3. How to force tsc to ignore node_modules folder?
  4. What is the pwa-node type launch configuration on VSCode?
  5. Go to the TypeScript source file instead of the type definition file in VS Code
  6. What is the –save option for npm install?
  7. How can I update NodeJS and NPM to their latest versions?
  8. Local dependency in package.json
  9. How to set environment variables from within package.json?
  10. NPM modules won’t install globally without sudo
  11. How do I install a module globally using npm?
  12. “message failed to fetch from registry” while trying to install any module
  13. NodeJS – Error installing with NPM
  14. How to use private Github repo as npm dependency
  15. npm ERR! Error: EPERM: operation not permitted, rename
  16. What is the difference between –save and –save-dev?
  17. How can I solve error gypgyp ERR!ERR! find VSfind VS msvs_version not set from command line or npm config?
  18. Error installing bcrypt with npm
  19. Purpose of installing Twitter Bootstrap through npm?
  20. npm WARN npm npm does not support Node.js v9.1.0
  21. How to NodeJS require inside TypeScript file?
  22. Extending TypeScript Global object in node.js
  23. npm ERR! Error: connect ECONNREFUSED when trying to update the npm
  24. What is the recommended way to install Node.js, nvm and npm on MacOS X?
  25. How to deploy node app that uses grunt to heroku
  26. How to make the webpack dev server run on port 80 and on 0.0.0.0 to make it publicly accessible?
  27. DeprecationWarning: Buffer() is deprecated due to security and usability issues when I move my script to another server
  28. GYP ERR! build error. stack Error: ‘make’ failed with exit code 2
  29. recommended typescript config for node 8
  30. How to store a file with file extension with multer?

Leave a Comment