link-type-definitions v0.3.9

link-type-definitions

link type definitions

Link and use 3rd party typescript defintions without DefinitelyTyped.

I build this because it is not possible to use type definitions without copy pasting them to the src/@types folder or submitting a pull request (and getting it accepted) from DefinitelyTyped.

Please ★ this repo if you found it useful ★ ★ ★

Installation

npm install -g link-type-definitions

Dependencies

• NodeJS

Usage

You can manually setup the project to link type definitions, or you can use the cli to automate the setup..

Setup your project

Navigate to the root of your project and run the following command.

link-type-definitions setup

This will add the following to your package.json.

package.json

{
  "scripts": {
    "postinstall": "link-type-definitions link"
  },
  "devDependencies": {
    "link-type-definitions": "^0.2.5"
  },
  "linkTypeDefinitions": []
}

You may need to reinstall your dependencies after running the setup.

npm install

Install npm modules that contain type definitions

npm install --save-dev <SOME_NPM_MODULE>

Link the modules types

Note that the module must be added to the package.json dependencies or devDependancies before linking its type definitions. Use the -S flag if you want to add the linked dependencies to the package.json.

link-type-definitions -S <SOME_NPM_MODULE>

Support

Submit an issue

Screenshots

Contribute a screenshot

Contributing

Review the guidelines for contributing

License

MIT License

Jam Risser © 2019

Changelog

Review the changelog

Credits

• Jam Risser - Author

Support on Liberapay

A ridiculous amount of coffee ☕ ☕ ☕ was consumed in the process of building this project.

Add some fuel if you'd like to keep me going!