electron-typed-ipc

v0.1.0

- no runtime cost (just typescript enhancements) - keeps the same API as Electron - separates events from commands to avoid confusions - events are things that happened (IPC) - commands are async functions you can invoke (RPC) For more information about how to use this package see README

Latest version published 4 years ago

License: MIT

NPM

GitHub

Package Health Score

47 / 100

security
No known security issues
popularity
Limited
maintenance
Inactive
community
Limited

Security

No known security issues

All security vulnerabilities belong to production dependencies of direct and indirect packages.

Security and license risk for significant versions

All Versions

Version				Vulnerabilities	License Risk
0.1.0	\|	05/2020	Popular	0 C 0 H 0 M 0 L	0 H 0 M 0 L

License

MIT

Security Policy

Is your project affected by vulnerabilities?

Scan your projects for vulnerabilities. Fix quickly with automated fixes. Get started with Snyk for free.

Get started free

Popularity

Limited

Weekly Downloads (93)

GitHub Stars: 8
Forks: 4
Contributors: -

Direct Usage Popularity

The npm package electron-typed-ipc receives a total of 93 downloads a week. As such, we scored electron-typed-ipc popularity level to be Limited.

Based on project statistics from the GitHub repository for the npm package electron-typed-ipc, we found that it has been starred 8 times.

Downloads are calculated as moving averages for a period of the last 12 months, excluding weekends and known missing data points.

Community

Limited

Readme.md: Yes
Contributing.md: No
Code of Conduct: No
Contributors: 0
Funding: No

This project has seen only 10 or less contributors.

We found a way for you to contribute to the project! Looks like electron-typed-ipc is missing a Code of Conduct.

Embed Package Health Score Badge

Maintenance

Inactive

Commit Frequency

No Recent Commits

Open Issues: 0
Open PR: 14
Last Release: 4 years ago
Last Commit: 4 months ago

Further analysis of the maintenance status of electron-typed-ipc based on released npm versions cadence, the repository activity, and other data points determined that its maintenance is Inactive.

An important project maintenance signal to consider for electron-typed-ipc is that it hasn't seen any new versions released to npm in the past 12 months, and could be considered as a discontinued project, or that which receives low attention from its maintainers.

In the past month we didn't find any pull request activity or change in issues status has been detected for the GitHub repository.

Keep your project healthy

Check your package.json

Ensure all the packages you're using are healthy and well-maintained

Snyk Vulnerability Scanner

Get health score & security insights directly in your IDE

Package

Node.js Compatibility: >=10

Age: 4 years
Dependencies: 0 Direct
Versions: 2
Install Size: 11 kB
Dist-tags: 1
# of Files: 14
Maintainers: 1
TS Typings: Yes

electron-typed-ipc has more than a single and default latest tag published for the npm package. This means, there may be other tags available for this package, such as next to indicate future releases, or stable to indicate stable releases.

Readme

Electron Typed IPC

no runtime cost (just typescript enhancements)
keeps the same API as Electron
separates events from commands to avoid confusions
- events are things that happened (IPC)
- commands are async functions you can invoke (RPC)

Usage

1. Install from npm

npm i electron-typed-ipc --save

2. Define your events/commands

type Events = {
  configUpdated: (newConfig?: Config, oldConfig?: Config) =&gt; void;
};

type Commands = {
  fetchConfig: () =&gt; Config;
  updateConfig: (newConfig: Partial) =&gt; void;
};

3. Add types to `ipcMain` and `ipcRenderer`

const typedIpcMain = ipcMain as TypedIpcMain;
const typesIpcRenderer = ipcRenderer as TypedIpcRenderer;

4. Emit events and invoke commands

// renderer.js
const config = await typedIpcRenderer.invoke('fetchConfig');

// main.js
typedIpcMain.handle('fetchConfig', () =&gt; {
  return { a: 1, b: 'text' };
});

// renderer.js
typedIpcRenderer.on('configUpdated', (_, newConfig, oldConfig) =&gt; {
  console.log(newConfig, oldConfig);
});

// main.ts
webContents
  .getAllWebContents()
  .forEach((renderer: TypedWebContents) =&gt; {
    renderer.send('configUpdated', newConfig, oldConfig);
  });

electron-typed-ipc development dependencies

husky tsdx tslib typescript

FAQs

What is electron-typed-ipc?

- no runtime cost (just typescript enhancements) - keeps the same API as Electron - separates events from commands to a... Visit Snyk Advisor to see a full health score report for electron-typed-ipc, including popularity, security, maintenance & community analysis.

Is electron-typed-ipc popular?

The npm package electron-typed-ipc receives a total of 93 weekly downloads. As such, electron-typed-ipc popularity was classified as limited. Visit the popularity section on Snyk Advisor to see the full health analysis.

Is electron-typed-ipc well maintained?

We found indications that electron-typed-ipc is an Inactive project. See the full package health analysis to learn more about the package maintenance status.

Is electron-typed-ipc safe to use?

The npm package electron-typed-ipc was scanned for known vulnerabilities and missing license, and no issues were found. Thus the package was deemed as safe to use. See the full health analysis review.

Last updated on 24 April-2024, at 02:32 (UTC).

Build a secure application checklist

Select a recommended open source package

Minimize your risk by selecting secure & well maintained open source packages

DONE

Scan your app for vulnerabilities

Scan your application to find vulnerabilities in your: source code, open source dependencies, containers and configuration files

SCAN NOW

Fix identified vulnerabilities

Easily fix your code by leveraging automatically generated PRs

AUTO FIX

Monitor for new issues

New vulnerabilities are discovered every day. Get notified if your application is affected

MONITOR APP