Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/agracio/electron-edge-js
Run .NET and Node.js code in-process on Windows, MacOS, and Linux
https://github.com/agracio/electron-edge-js
Last synced: about 1 month ago
JSON representation
Run .NET and Node.js code in-process on Windows, MacOS, and Linux
- Host: GitHub
- URL: https://github.com/agracio/electron-edge-js
- Owner: agracio
- License: mit
- Created: 2017-09-09T12:04:50.000Z (about 7 years ago)
- Default Branch: master
- Last Pushed: 2024-09-26T19:28:18.000Z (about 2 months ago)
- Last Synced: 2024-09-26T19:30:14.976Z (about 2 months ago)
- Language: C++
- Homepage:
- Size: 13.1 MB
- Stars: 349
- Watchers: 18
- Forks: 92
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# .NET and Node.js in-process on Electron
[](https://github.com/agracio/electron-edge-js/actions)
[![Git Issues][issues-img]][issues-url]
[![Closed Issues][closed-issues-img]][closed-issues-url]
**This is a fork of [edge-js](https://github.com/agracio/edge-js) adapted to support [Electron](https://github.com/electron/electron/)**
### Windows binaries pre-compiled for
| Electron | Node.Js | x86/x64 | arm64 |
| --------------- | ---------------- | ------------------ | ------------------ |
| Electron 26.x | v18.16.1 | :heavy_check_mark: | :x: |
| Electron 27.x | v18.17.1 | :heavy_check_mark: | :x: |
| Electron 28.x | v18.18.2 | :heavy_check_mark: | :x: |
| Electron 29.x | v20.9.0 | :heavy_check_mark: | :heavy_check_mark: |
| Electron 30.x | v20.x | :heavy_check_mark: | :heavy_check_mark: |
| Electron 31.x | v20.x | :heavy_check_mark: | :heavy_check_mark: |
| Electron 32.x | v20.x | :heavy_check_mark: | :heavy_check_mark: |
- You do not need to use the same version of Node.js in your project as Electron Node.js version
- On Linux and macOS `npm install` will compile binaries with correct Node.Js headers for a given Electron version.
#### Usage is the same as edge-js, replace `require('edge-js')` with `require('electron-edge-js')`:
```bash
npm install electron-edge-js
```
```diff
-var edge = require('edge-js');
+var edge = require('electron-edge-js');
var helloWorld = edge.func(function () {/*
async (input) => {
return ".NET Welcomes " + input.ToString();
}
*/});
```
## Why use `electron-edge-js`?
Electron is built using specific version of Node.js. To use `edge-js` in Electron project you would need to recompile it using the same Node.js version and Electron headers.
`electron-edge-js` comes precompiled with correct Node.js versions and headers.
## Quick start
Sample app that shows how to work with .NET Core using inline code and compiled C# libraries.
https://github.com/agracio/electron-edge-js-quick-start
## Packaging Electron application
`electron-edge-js` needs to be specified as an external module, some examples
``webpack.config.js ``
```js
externals: {
'electron-edge-js': 'commonjs2 electron-edge-js',
},
node: {
__dirname: true,
__filename: true,
},
```
``vue.config.js``
```js
module.export = {
pluginOptions: {
electronBuilder: {
externals:["electron-edge-js"]
}
}
}
```
### From [#138](https://github.com/agracio/electron-edge-js/issues/138)
``webpack.config.js ``
```js
externals: {
'electron-edge-js': 'commonjs2 electron-edge-js',
},
node: {
__dirname: false,
__filename: false,
},
extraResources:[
"./node_modules/electron-edge-js/**",
]
```
Electron `main.js`
```js
// https://github.com/ScottJMarshall/electron-webpack-module-resolution
require("module").globalPaths.push(process.cwd()+'/node_modules');
var edge = require('electron-edge-js');
```
Related issues to use for troubleshooting:
https://github.com/agracio/electron-edge-js/issues/39
https://github.com/agracio/electron-edge-js/issues/74
https://github.com/agracio/electron-edge-js/issues/21
## electron-forge
electron-forge example based on `electron-edge-js-quick-start`
https://github.com/agracio/electron-edge-js-quick-start-forge
## Async execution
If `electron-edge-js` module is used on main Electron thread it will cause Electron app to freeze when executing long-running .NET code even if your C# code is fully async.
To avoid this you can use worker thread packages such as **[threads.js](https://www.npmjs.com/package/threads)** or **[piscina](https://www.npmjs.com/package/piscina)**
This issue is not present when using Electron [IPC](https://www.electronjs.org/docs/latest/tutorial/ipc)
### Workaround from [#97]( https://github.com/agracio/electron-edge-js/issues/97)
`main.js`
```js
const { fork } = require("child_process"); fork("../child.js", [], { env: {file: 'filename'}, })
```
`child.js`
```js
const path = require('path');
const powerpoint = require('office-script').powerpoint;
const filePath = '../../directory/';
powerpoint.open(path.join(${remotePath}${process.env.file}.pptx), function(err) {
if(err) throw err;
});
```
## Window refresh issue
If `electron-edge-js` module is used on main Electron thread refreshing the window (F5, Ctrl+R, Command+R etc) will cause a hard crash in `electron-edge-js` module and Electron app.
Currently there is no solution to this issue other than using Electron [IPC](https://www.electronjs.org/docs/latest/tutorial/ipc).
## Build
build.bat supports only Electron major versions.
## Documentation
For full documentation see [edge-js](https://github.com/agracio/edge-js) repo.
[issues-img]: https://img.shields.io/github/issues/agracio/electron-edge-js.svg?style=flat-square
[issues-url]: https://github.com/agracio/electron-edge-js/issues
[closed-issues-img]: https://img.shields.io/github/issues-closed-raw/agracio/electron-edge-js.svg?style=flat-square&color=brightgreen
[closed-issues-url]: https://github.com/agracio/electron-edge-js/issues?q=is%3Aissue+is%3Aclosed