Haxe type definitions for the electron framework

License: MIT

Language: Haxe

Keywords: electron, externs, haxe


Haxe type definitions for electron, a framework for building cross-platform desktop applications with JavaScript, HTML, and CSS.

Build Status Haxelib Version


# Release version
haxelib install electron

# Development version
haxelib git electron

Generate Type Definitions

All type definitions are generated from electron-api.json by ElectronAPI.hx.
To (re)generate for another electron version download the description file from and run:

## Generate type definitions
haxe --macro ElectronAPI.generate("optional/path/to/electron-api.json")

## Build haxedoc.xml to insure everything is fine
haxe haxedoc.hxml

By default hxelectron/electron-api.json is used if you ommit the path argument to your custom description file.


Demo Application

Spin up the included demo application to see electron in action:

## Clone this repository
git clone
cd hxelectron/

## Set the haxelib development directory
haxelib dev electron .

## Install electron, build and run the application
cd demo/
haxe build.hxml
npm install
npm run start


The haxe externs are attributed with following metadata:

  • @:electron_platforms(["Linux"|"macOS"|"Windows"]) the supporting platforms (only if specific).

Project Statistics

Sourcerank 7
Repository Size 1.76 MB
Stars 71
Forks 12
Watchers 6
Open issues 6
Dependencies 2
Contributors 7
Tags 69
Last updated
Last pushed

Top Contributors See all

70/V9 Franco Ponticelli Skial Bainn Ryan Davis Alexander Gordeyko Matthijs Kamstra Nykkolas

Packages Referencing this Repo

Type definitions for the electron framework
Latest release 7.1.8 - Updated - 71 stars

Recent Tags See all

v7.1.8 January 09, 2020
v7.1.7 December 20, 2019
v7.1.6 December 18, 2019
v7.1.5 December 14, 2019
v7.1.4 December 10, 2019
v7.1.3 December 04, 2019
v7.1.2 December 01, 2019
v6.0.12 October 09, 2019
v6.0.11 October 02, 2019
v6.0.10 September 19, 2019
v6.0.9 September 13, 2019
v6.0.8 September 10, 2019
v6.0.7 September 02, 2019
v6.0.6 August 30, 2019
v6.0.5 August 28, 2019

Something wrong with this page? Make a suggestion

Last synced: 2020-01-09 09:24:39 UTC

Login to resync this repository