Need private packages and team management tools?Check out npm Teams »

electron-typescript-definitions

8.3.0 • Public • Published

Electron TypeScript Definitions Build Status

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

Keywords

none

Install

npm i electron-typescript-definitions

DownloadsWeekly Downloads

318

Version

8.3.0

License

MIT

Unpacked Size

487 kB

Total Files

20

Last publish

Collaborators

  • avatar
  • avatar
  • avatar
  • avatar
  • avatar