npm.io
1.0.2 • Published 4 years ago

dts-extractor

Licence
MIT
Version
1.0.2
Deps
1
Size
11 kB
Vulns
0
Weekly
0
Stars
7
SummaryDependencyVersions

dts-extractor Build Status codecov npm

Extract definition files from local node modules.

Installation & Usage

npm install dts-extractor

Usage:

const dtsExtractor = require('dts-extractor');

(async () => {
    const dts = await dtsExtractor.getDts({
        nodeModulesPath: './node_modules', // path in file system where packages located
        packages: ['xlstream', '@types/moment'], // list of packages 
    });
})();

Usage with Monaco Editor

One of the use-cases for this package is to supply custom typings for Monaco Editor. When typings are extracted as shown in the code snippet above, they can be plugged in to Monaco Editor:

for (const key of Object.keys(dts)) {
    monaco.languages.typescript.typescriptDefaults.addExtraLib(dts[key], key);
}

In result, IntelliSense will be enabled for desired packages: monaco-editor-intellisense

Keywords

dtstype-definition