npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

comlink-electron-adapter

v0.0.1

Published

[![Build Status](https://travis-ci.com/kwonoj/comlink-electron-adapter.svg)](https://travis-ci.com/kwonoj/comlink-electron-adapter) [![Build status](https://ci.appveyor.com/api/projects/status/51vn1y7yygjfcl98/branch/master?svg=true)](https://ci.appveyor.

Downloads

7

Readme

Build Status Build status codecov npm node

Comlink-electron-adapter

Comlink provides way to interface between worker-like endpoint via ES proxy. This module allows to create custom endpoints around Electron's IPC (https://electronjs.org/docs/api/ipc-main) for proxy object across Electron's processes.

Install

This has a peer dependencies of comlink@4, which will have to be installed as well

npm install comlink-electron-adapter

Usage

There are separate endpoint creation method per object's origin.

Expose main process's object to renderer project

// main process
import { ipcMain } from 'electron';
import { expose } from 'comlink';
import { mainProcObjectEndpoint } from 'comlink-electron-adapter';

const mainProcessObject = {...};
expose(mainProcessObject, mainProcObjectEndpoint(ipcMain));

// renderer process
import { wrap } from 'comlink';
import { ipcRenderer } from 'electron';

// `proxied` is proxy object to `mainProcessObject` in main process
const proxied = wrap(mainProcObjectEndpoint(ipcRenderer));

Expose renderer process's object to main process

It is also possible to access renderer process's object in main process.

// renderer process
import { expose } from 'comlink';
import { ipcRenderer } from 'electron';
import { rendererProcObjectEndpoint } from 'comlink-electron-adapter';

const rendererProcessObject = {...};
expose(rendererProcessObject, rendererProcObjectEndpoint(ipcRenderer));

// main process
import { wrap } from 'comlink';
import { ipcMain } from 'electron';
import { rendererProcObjectEndpoint } from 'comlink-electron-adapter';

const rendererProcessWindow = new BrowserWindow();
rendererProcessWindow.loadFile('.../renderer.js');

const proxied = wrap(requestRendererProcessEndpoint(ipcMain, rendererProcessWindow.webContents));

Unlike renderer process main process does not aware target renderer process to send message and target webContents should be specified. Also main process should wait call proxy object until renderer process expose its object.

Note

Due to Electron IPC's design comlink-electron-adapter do not support transferable. Using Comlink.transfer will raise not supported exception.

Building / Testing

Few npm scripts are supported for build / test code.

  • build: Transpiles code to ES5 commonjs to dist.
  • test: Run test cases.
  • lint: Run lint over all codebases
  • lint:staged: Run lint only for staged changes. This'll be executed automatically with precommit hook.
  • commit: Commit wizard to write commit message

License

MIT