b1be1a4806
|
||
|---|---|---|
| base | ||
| lib | ||
| scripts | ||
| test | ||
| test-smoke | ||
| vendor | ||
| .gitignore | ||
| .npmignore | ||
| .travis.yml | ||
| README.md | ||
| cli.js | ||
| index.js | ||
| package.json | ||
| tslint.json | ||
| yarn.lock | ||
README.md
electron-DefinitelyTyped 
Parse Electron's JSON API documentation and spit out a typescript definition file
Installation
npm install electron-DefinitelyTyped --save
CLI Usage
To generate the definitions
electron-DefinitelyTyped --in=path/to/electron/api.json --out=path/to/electron.d.ts
Any warnings during the generation can normally be ignored unless it actually throws an error
Programmatic Usage
The module exports a function that parses a given API JSON object and returns an array of lines to create the definition file
const generateDefinitions = require('electron-DefinitelyTyped')
const apiPath = './vendor/electron/docs/api.json'
const definitionLines = generateDefinitions(require(apiPath))
// definitionLines will be an array of file lines
License
MIT