{"id":18783488,"url":"https://github.com/tong/hxelectron","last_synced_at":"2025-12-15T04:24:03.621Z","repository":{"id":29090279,"uuid":"32619387","full_name":"tong/hxelectron","owner":"tong","description":"Haxe type definitions for electron","archived":false,"fork":false,"pushed_at":"2025-02-14T09:11:07.000Z","size":10569,"stargazers_count":107,"open_issues_count":10,"forks_count":15,"subscribers_count":7,"default_branch":"master","last_synced_at":"2025-03-29T11:10:27.275Z","etag":null,"topics":["electron","externs","haxe"],"latest_commit_sha":null,"homepage":"","language":"Haxe","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/tong.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":".github/FUNDING.yml","license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null},"funding":{"github":"tong"}},"created_at":"2015-03-21T04:05:03.000Z","updated_at":"2025-02-26T14:13:47.000Z","dependencies_parsed_at":"2023-02-18T10:01:04.191Z","dependency_job_id":"39577e76-9feb-4c03-b697-8f268e74549a","html_url":"https://github.com/tong/hxelectron","commit_stats":null,"previous_names":["fponticelli/hxelectron"],"tags_count":231,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tong%2Fhxelectron","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tong%2Fhxelectron/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tong%2Fhxelectron/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tong%2Fhxelectron/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/tong","download_url":"https://codeload.github.com/tong/hxelectron/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247332612,"owners_count":20921853,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["electron","externs","haxe"],"created_at":"2024-11-07T20:39:28.154Z","updated_at":"2025-12-15T04:24:03.568Z","avatar_url":"https://github.com/tong.png","language":"Haxe","funding_links":["https://github.com/sponsors/tong"],"categories":[],"sub_categories":[],"readme":"HXElectron\n==========\nHaxe type definitions for [electron](https://electronjs.org/), a framework for building cross-platform desktop applications with JavaScript, HTML, and CSS.\n\n[![test](https://github.com/tong/hxelectron/actions/workflows/test.yml/badge.svg)](https://github.com/tong/hxelectron/actions/workflows/test.yml) [![Haxelib Version](https://img.shields.io/github/tag/tong/hxelectron.svg?style=flat-square\u0026colorA=EA8220\u0026colorB=FBC707\u0026label=haxelib)](http://lib.haxe.org/p/electron/)\n\n\n## Install\n\nRelease version\n```sh\nhaxelib install electron\n```\n\nDevelopment version\n```sh\nhaxelib git electron https://github.com/tong/hxelectron.git\n```\n\n---\n\n## Generate Type Definitions\n\nAll type definitions are generated from [electron-api.json](electron-api.json) by [ElectronAPI.hx](ElectronAPI.hx).  \nTo (re)generate for another electron version download the description file from https://github.com/electron/electron/releases and run:\n```sh\nhaxe --macro ElectronAPI.generate(\"optional/path/to/electron-api.json\")\n```\n\nBuild `haxedoc.xml` to insure everything is fine:\n```sh\nhaxe haxedoc.hxml\n```\n\nBy default `hxelectron/electron-api.json` is used if you ommit the path argument to your custom description file.\n\n---\n\n### Metadata\n\nThe haxe externs are attributed with following metadata:\n - `@:electron_platforms([\"Linux\"|\"macOS\"|\"Windows\"])` the supporting platforms (only if specific).\n\n---\n\n## Usage\n\n### Demo Application\n\nClone this repository and setup: \n```sh\ngit clone https://github.com/tong/hxelectron\ncd hxelectron/\nhaxelib dev electron .\n```\n\nBuild and Run:\n```sh\ncd demo/\nnpm install # Install electron\nnpm run build # Build main.js, app.js\nnpm start # Run application\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftong%2Fhxelectron","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ftong%2Fhxelectron","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftong%2Fhxelectron/lists"}