electron/docs/glossary.md

183 lines
7.1 KiB
Markdown
Raw Normal View History

2016-11-03 20:53:40 +00:00
# Glossary
This page defines some terminology that is commonly used in Electron development.
2016-11-04 18:28:59 +00:00
### ASAR
2016-11-03 20:53:40 +00:00
ASAR stands for Atom Shell Archive Format. An [asar][asar] archive is a simple
`tar`-like format that concatenates files into a single file. Electron can read
arbitrary files from it without unpacking the whole file.
The ASAR format was created primarily to improve performance on Windows... TODO
2016-11-04 18:28:59 +00:00
### Brightray
2016-11-03 20:53:40 +00:00
Brightray [was](https://github.com/electron-archive/brightray) a static library
that made [libchromiumcontent] easier to use in applications. It is now
deprecated and has been merged into Electron's codebase.
2016-11-03 20:53:40 +00:00
2017-06-16 00:28:00 +00:00
### CRT
2017-06-16 17:21:24 +00:00
The C Run-time Library (CRT) is the part of the C++ Standard Library that
2017-06-16 00:28:00 +00:00
incorporates the ISO C99 standard library. The Visual C++ libraries that
implement the CRT support native code development, and both mixed native and
2017-06-16 17:21:24 +00:00
managed code, and pure managed code for .NET development.
2017-06-16 00:28:00 +00:00
2016-11-06 03:07:36 +00:00
### DMG
An Apple Disk Image is a packaging format used by macOS. DMG files are
commonly used for distributing application "installers". [electron-builder]
supports `dmg` as a build target.
2017-06-26 17:04:46 +00:00
### IME
Input Method Editor. A program that allows users to enter characters and
symbols not found on their keyboard. For example, this allows users of Latin
keyboards to input Chinese, Japanese, Korean and Indic characters.
2016-11-04 18:28:59 +00:00
### IPC
2016-11-03 20:53:40 +00:00
IPC stands for Inter-Process Communication. Electron uses IPC to send
serialized JSON messages between the [main] and [renderer] processes.
2016-11-04 18:28:59 +00:00
### libchromiumcontent
2016-11-03 20:53:40 +00:00
A shared library that includes the [Chromium Content module] and all its
dependencies (e.g., Blink, [V8], etc.). Also referred to as "libcc".
- [github.com/electron/libchromiumcontent](https://github.com/electron/libchromiumcontent)
2016-11-03 20:53:40 +00:00
2016-11-04 18:28:59 +00:00
### main process
2016-11-03 20:53:40 +00:00
The main process, commonly a file named `main.js`, is the entry point to every
Electron app. It controls the life of the app, from open to close. It also
manages native elements such as the Menu, Menu Bar, Dock, Tray, etc. The
main process is responsible for creating each new renderer process in the app.
The full Node API is built in.
Every app's main process file is specified in the `main` property in
`package.json`. This is how `electron .` knows what file to execute at startup.
2017-09-22 01:52:43 +00:00
In Chromium, this process is referred to as the "browser process". It is
renamed in Electron to avoid confusion with renderer processes.
2016-12-21 21:47:17 +00:00
See also: [process](#process), [renderer process](#renderer-process)
2016-11-04 18:28:59 +00:00
### MAS
2016-11-03 20:53:40 +00:00
Acronym for Apple's Mac App Store. For details on submitting your app to the
MAS, see the [Mac App Store Submission Guide].
2016-11-04 18:28:59 +00:00
### native modules
2016-11-03 20:53:40 +00:00
2016-11-04 18:24:41 +00:00
Native modules (also called [addons] in
2016-11-03 20:53:40 +00:00
Node.js) are modules written in C or C++ that can be loaded into Node.js or
Electron using the require() function, and used just as if they were an
ordinary Node.js module. They are used primarily to provide an interface
between JavaScript running in Node.js and C/C++ libraries.
Native Node modules are supported by Electron, but since Electron is very
likely to use a different V8 version from the Node binary installed in your
system, you have to manually specify the location of Electrons headers when
building native modules.
2016-11-04 18:24:41 +00:00
See also [Using Native Node Modules].
2016-11-03 20:53:40 +00:00
### NSIS
2016-11-06 03:07:36 +00:00
Nullsoft Scriptable Install System is a script-driven Installer
authoring tool for Microsoft Windows. It is released under a combination of
free software licenses, and is a widely-used alternative to commercial
proprietary products like InstallShield. [electron-builder] supports NSIS
as a build target.
2017-10-21 22:15:30 +00:00
### OSR
2017-07-07 20:43:54 +00:00
2017-10-21 22:15:30 +00:00
OSR (Off-screen rendering) can be used for, e.g., loading heavy page in
background and then displaying it after (it will be much more faster).
It allows you to render page without show on screen.
2016-11-06 03:07:36 +00:00
2016-11-04 18:28:59 +00:00
### process
2016-11-04 18:24:41 +00:00
A process is an instance of a computer program that is being executed. Electron
apps that make use of the [main] and one or many [renderer] process are
actually running several programs simultaneously.
In Node.js and Electron, each running process has a `process` object. This
object is a global that provides information about, and control over, the
current process. As a global, it is always available to applications without
using require().
2016-12-21 21:47:17 +00:00
See also: [main process](#main-process), [renderer process](#renderer-process)
2016-11-04 18:28:59 +00:00
### renderer process
2016-11-03 20:53:40 +00:00
The renderer process is a browser window in your app. Unlike the main process,
there can be multiple of these and each is run in a separate process.
They can also be hidden.
In normal browsers, web pages usually run in a sandboxed environment and are not
allowed access to native resources. Electron users, however, have the power to
use Node.js APIs in web pages allowing lower level operating system
interactions.
2016-12-21 21:47:17 +00:00
See also: [process](#process), [main process](#main-process)
2016-11-04 18:28:59 +00:00
### Squirrel
2016-11-03 20:53:40 +00:00
Squirrel is an open-source framework that enables Electron apps to update
automatically as new versions are released. See the [autoUpdater] API for
info about getting started with Squirrel.
2016-11-04 18:28:59 +00:00
### userland
2016-11-03 20:53:40 +00:00
This term originated in the Unix community, where "userland" or "userspace"
referred to programs that run outside of the operating system kernel. More
recently, the term has been popularized in the Node and npm community to
distinguish between the features available in "Node core" versus packages
published to the npm registry by the much larger "user" community.
2016-11-06 03:07:36 +00:00
Like Node, Electron is focused on having a small set of APIs that provide
all the necessary primitives for developing multi-platform desktop applications.
2016-11-03 20:53:40 +00:00
This design philosophy allows Electron to remain a flexible tool without being
overly prescriptive about how it should be used. Userland enables users to
create and share tools that provide additional functionality on top of what is
available in "core".
2016-11-04 18:28:59 +00:00
### V8
2016-11-03 20:53:40 +00:00
V8 is Google's open source JavaScript engine. It is written in C++ and is
used in Google Chrome. V8 can run standalone, or can be embedded into any C++ application.
Electron builds V8 as part of Chromium and then points Node to that V8 when
building it.
V8's version numbers always correspond to those of Google Chrome. Chrome 59
includes V8 5.9, Chrome 58 includes V8 5.8, etc.
- [developers.google.com/v8](https://developers.google.com/v8)
- [nodejs.org/api/v8.html](https://nodejs.org/api/v8.html)
- [docs/development/v8-development.md](development/v8-development.md)
2016-11-03 20:53:40 +00:00
2016-11-04 18:28:59 +00:00
### webview
2016-11-04 18:24:41 +00:00
`webview` tags are used to embed 'guest' content (such as external web pages) in
your Electron app. They are similar to `iframe`s, but differ in that each
webview runs in a separate process. It doesn't have the same
permissions as your web page and all interactions between your app and
embedded content will be asynchronous. This keeps your app safe from the
embedded content.
2016-11-03 20:53:40 +00:00
[addons]: https://nodejs.org/api/addons.html
2016-12-26 09:28:08 +00:00
[asar]: https://github.com/electron/asar
2016-11-03 20:53:40 +00:00
[autoUpdater]: api/auto-updater.md
[Chromium Content module]: https://www.chromium.org/developers/content-module
2016-11-06 03:07:36 +00:00
[electron-builder]: https://github.com/electron-userland/electron-builder
2016-11-03 20:53:40 +00:00
[libchromiumcontent]: #libchromiumcontent
[Mac App Store Submission Guide]: tutorial/mac-app-store-submission-guide.md
2016-11-03 20:53:40 +00:00
[main]: #main-process
[renderer]: #renderer-process
[userland]: #userland
[Using Native Node Modules]: tutorial/using-native-node-modules.md
2016-11-03 20:53:40 +00:00
[V8]: #v8