niik / electron-typescript-definitions

Convert the Electron API JSON file to electron.d.ts

Electron TypeScript Definitions

This module uses Electron's JSON API documentation to produce a TypeScript definition file for the Electron API.

Installation

npm install electron-typescript-definitions --save

CLI Usage

To generate the definitions

electron-typescript-definitions --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-typescript-definitions')
const apiPath = './vendor/electron/docs/api.json'

const definitionLines = generateDefinitions(require(apiPath))
// definitionLines will be an array of file lines

License

MIT