No description
Find a file
Samuel Attard 81795744cf
fix: ensure the typescript definitions only export correct value types (#28712)
* fix: ensure the typescript definitions only export correct value types

In typescript there are two main types of "types" you can export, value types (class, const) and definition types (type, interface).  The typescript compiler will let anything declared via const or class be used as a value.  Unfortunately we were exporting a bunch of things (see the diff) as class/const when they weren't actually exported values. This lead to typescript being happy but the runtime throwing errors (not something we want).

This change passes "exported-in" context through our docs, to the parser and then to the definitions generator to ensure we only mark things as exported in the ts defs that we actually export.

Fixes #22167

* chore: update typescript-defs

* chore: update typescript-defs

* chore: fix bad typescript in IPC test

* docs: test rendering of new syntax

* chore: update per feedback, use same syntax but with 'this is not exportedd' line
2021-06-15 13:50:31 -07:00
.circleci build: restore workspace on osx builds to get docs-only-change file (#29465) 2021-06-14 12:20:59 -07:00
.github chore: add wg-security as required reviewer for other files with IPC handlers (#29092) 2021-05-12 12:04:06 -07:00
.husky chore: Update husky v6.0.0 (#28827) 2021-04-29 09:46:15 +02:00
build fix: ensure fuse order is read in a stable way (#29599) 2021-06-09 08:30:02 -07:00
buildflags Merge branch 'master' into roller/chromium/master 2021-03-15 18:43:25 -04:00
chromium_src refactor: use std::make_unique/base::MakeRefCounted when possible (#29637) 2021-06-15 09:37:55 +09:00
default_app refactor: use PathProvider for user-data-dir and others (#29649) 2021-06-15 09:32:56 +09:00
docs fix: ensure the typescript definitions only export correct value types (#28712) 2021-06-15 13:50:31 -07:00
lib refactor: use PathProvider for user-data-dir and others (#29649) 2021-06-15 09:32:56 +09:00
npm feat: allow path override with --ignore-scripts (#25377) 2020-12-03 16:23:44 +09:00
patches chore: bumping NAN dep to include test changes (#29686) 2021-06-15 16:09:39 -04:00
script build: remove individual release build workflows (#29344) 2021-06-07 10:17:27 -04:00
shell chore: disable default async spellchecker on Windows (#29690) 2021-06-15 09:11:49 -07:00
spec test: re-enable some skipped tests (#29655) 2021-06-15 10:55:08 +09:00
spec-main fix: ensure the typescript definitions only export correct value types (#28712) 2021-06-15 13:50:31 -07:00
typings refactor: use PathProvider for user-data-dir and others (#29649) 2021-06-15 09:32:56 +09:00
.clang-format Add clang-format config file. 2016-10-04 22:42:49 +02:00
.dockerignore build: remove unused install-build-deps (#26891) 2020-12-09 09:26:21 -08:00
.env.example build: do not require vsts token for releases (#28643) 2021-04-13 15:30:46 -07:00
.eslintrc.json feat: add webContents.setWindowOpenHandler API (#24517) 2020-11-10 09:06:03 -08:00
.gitattributes chore: force source code and markdown files to use LF line ending (#25134) 2020-08-27 10:25:39 +09:00
.gitignore build: remove the vendor directory (#28883) 2021-04-28 00:38:08 -07:00
.markdownlint.autofix.json chore: use markdownlint to lint the docs (#26792) 2021-01-14 17:31:26 +09:00
.markdownlint.json fix: ensure the typescript definitions only export correct value types (#28712) 2021-06-15 13:50:31 -07:00
.remarkrc add remark lint to ensure fenced codeblocks are formatted properly. 2017-11-20 14:05:47 +08:00
appveyor.yml build: enable woa testing (#28952) 2021-05-03 09:53:51 -04:00
azure-pipelines-arm.yml ci: enable arm64 macOS tests (#24832) 2021-01-21 18:36:52 -05:00
azure-pipelines-woa.yml ci: ignore errors deleting user app directories on WOA testing (#27709) 2021-02-15 09:44:32 +09:00
BUILD.gn feat: add experimental cookie encryption support (#27524) 2021-05-26 12:16:55 -07:00
CODE_OF_CONDUCT.md docs: use asterisks for unordered lists (#26552) 2020-11-23 12:15:27 -05:00
CONTRIBUTING.md chore: tidy up markdown (#26554) 2020-11-18 20:58:47 -08:00
DEPS chore: bumping NAN dep to include test changes (#29686) 2021-06-15 16:09:39 -04:00
electron_paks.gni chore: media_internal_resources becomes resources 2021-03-04 15:53:46 -08:00
electron_resources.grd feat: enable pdf viewer (#21794) 2020-02-12 16:39:12 -08:00
electron_strings.grdp chore: bump chromium to 92.0.4475.0 (master) (#28462) 2021-04-15 10:44:35 -07:00
ELECTRON_VERSION Bump v15.0.0-nightly.20210615 2021-06-15 06:01:55 -07:00
filenames.auto.gni refactor: implement <webview> using contextBridge (#29037) 2021-05-15 16:42:07 +09:00
filenames.gni fix: load source maps from custom protocols and asar bundles (#28573) 2021-04-11 21:59:36 -07:00
filenames.hunspell.gni chore: bump chromium to 6d130075d378a64187360ba4e7820 (master) (#24256) 2020-07-13 21:13:34 -04:00
filenames.libcxx.gni test: rebuild nan tests with libc++ and libc++abi (#29281) 2021-05-22 11:48:38 -07:00
filenames.libcxxabi.gni test: rebuild nan tests with libc++ and libc++abi (#29281) 2021-05-22 11:48:38 -07:00
LICENSE chore: update copyright headers (#27697) 2021-02-12 15:22:41 -08:00
package.json fix: ensure the typescript definitions only export correct value types (#28712) 2021-06-15 13:50:31 -07:00
README.md docs: remove devDependencies badge from README (#29499) 2021-06-03 09:44:48 -07:00
SECURITY.md chore: tidy up markdown (#26554) 2020-11-18 20:58:47 -08:00
tsconfig.default_app.json chore: fix ts config to not complain about extraneous files (#16790) 2019-02-06 15:46:10 -08:00
tsconfig.electron.json chore: fix ts config to not complain about extraneous files (#16790) 2019-02-06 15:46:10 -08:00
tsconfig.json chore: update to latest TypeScript, which has built-in WeakRef declarations (#27425) 2021-01-22 11:25:47 -08:00
tsconfig.script.json build: auto-push patch file changes (#26235) 2020-10-29 14:21:23 -04:00
tsconfig.spec.json spec: initial spike of main-process based tests 2019-03-14 12:50:06 -07:00
vsts-arm-test-steps.yml chore: bump chromium to 92.0.4475.0 (master) (#28462) 2021-04-15 10:44:35 -07:00
vsts-arm32v7.yml build: update docker images to node 14 (#27915) 2021-03-01 20:45:20 +09:00
vsts-arm64v8.yml build: update docker images to node 14 (#27915) 2021-03-01 20:45:20 +09:00
yarn.lock fix: ensure the typescript definitions only export correct value types (#28712) 2021-06-15 13:50:31 -07:00

Electron Logo

CircleCI Build Status AppVeyor Build Status Electron Discord Invite

📝 Available Translations: 🇨🇳 🇧🇷 🇪🇸 🇯🇵 🇷🇺 🇫🇷 🇺🇸 🇩🇪. View these docs in other languages at electron/i18n.

The Electron framework lets you write cross-platform desktop applications using JavaScript, HTML and CSS. It is based on Node.js and Chromium and is used by the Atom editor and many other apps.

Follow @ElectronJS on Twitter for important announcements.

This project adheres to the Contributor Covenant code of conduct. By participating, you are expected to uphold this code. Please report unacceptable behavior to coc@electronjs.org.

Installation

To install prebuilt Electron binaries, use npm. The preferred method is to install Electron as a development dependency in your app:

npm install electron --save-dev

For more installation options and troubleshooting tips, see installation. For info on how to manage Electron versions in your apps, see Electron versioning.

Quick start & Electron Fiddle

Use Electron Fiddle to build, run, and package small Electron experiments, to see code examples for all of Electron's APIs, and to try out different versions of Electron. It's designed to make the start of your journey with Electron easier.

Alternatively, clone and run the electron/electron-quick-start repository to see a minimal Electron app in action:

git clone https://github.com/electron/electron-quick-start
cd electron-quick-start
npm install
npm start

Resources for learning Electron

Programmatic usage

Most people use Electron from the command line, but if you require electron inside your Node app (not your Electron app) it will return the file path to the binary. Use this to spawn Electron from Node scripts:

const electron = require('electron')
const proc = require('child_process')

// will print something similar to /Users/maf/.../Electron
console.log(electron)

// spawn Electron
const child = proc.spawn(electron)

Mirrors

Documentation Translations

Find documentation translations in electron/i18n.

Contributing

If you are interested in reporting/fixing issues and contributing directly to the code base, please see CONTRIBUTING.md for more information on what we're looking for and how to get started.

Community

Info on reporting bugs, getting help, finding third-party tools and sample apps, and more can be found in the support document.

License

MIT

When using the Electron or other GitHub logos, be sure to follow the GitHub logo guidelines.