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

@getstation/rx-ipc-electron

v0.3.0

Published

Pass RxJS Observables through IPC in Electron

Downloads

10

Readme

Rx-IPC-Electron

Build Status

Easily pass RxJS Observables between the main and renderer processes of your Electron app!

Why

Observables are probably the simplest way to coordinate asynchronous events and pass data between the main and renderer processes in an Electron app.

This module makes it easy. Simply create a factory function which returns any Observable or Subject and register a listener. Then run the command from another process in your app and the returned observable will pass through.

Setup

npm install rx-ipc-electron --save

From the Electron MAIN process

import rxIpc from 'rx-ipc-electron/lib/main';
// const rxIpc = require('rx-ipc-electron/lib/main');

From the Electron RENDERER process

import rxIpc from 'rx-ipc-electron/lib/renderer';
// const rxIpc = require('rx-ipc-electron/lib/renderer');

Quick Start

MAIN

// This is a factory function that returns an Observable
function createObservable(...args) {
  return Observable.from(args)
    .map(x => x * 2);
}
rxIpc.registerListener('create-observable', createObservable);

RENDERER

const results = [];
// null to target the main process, otherwise a `webContents`
// object from the window you want to target
rxIpc.runCommand('create-observable', null, 1, 2, 3)
  .subscribe(
    (data) => {
      results.push(data);
    },
    (err) => {
      console.error(err);
    },
    () => {
      console.log(results);
      // Logs [2, 4, 6]
    }
  );

API

`new RxIpc(icpRenderer | ipcMain, options)

options.ipcChannelPrefix

When sending and receiving IPC message use a prefix for channel name.

Can be used to fix collisions between several instances of rpx-ipc-electron.

rxIpc.checkRemoteListener(channel, receiver)

Checks if a listener is active on the receiver for the channel you specify.

  • channel (string) the name of the command you want to check.
  • receiver (null or webContents) null if the main process is the target, otherwise the webContents object of the window you want to target.

Returns: a Promise that is resolved if the listner is active, otherwise rejected.

rxIpc.cleanUp()

Removes all active command listeners.

Returns: void

rxIpc.registerListener(channel, observableFactory)

Registers a new listener for the command you specify.

  • channel (string) the name of the command you want to register.
  • observableFactory (function) a function which can take any number of arguments (passed through from rxIpc.runCommand) and returns an Observable.

Returns: void.

rxIpc.removeListeners(channel)

Removes all listeners for the channel you specify.

  • channel (string) the name of the command for the listener you want to remove.

Returns: void.

rxIpc.runCommand(channel, receiver, ...args)

Runs the command you specify on the remote receiver.

  • channel (string) the name of the registered command you want to run.
  • receiver (null or webContents) null if the main process is the target, otherwise the webContents object of the window you want to target.
  • ...args any number of arguments to be passed to the remote Observable factory function.

Returns: an Observable passed through from the remote Observable.

Release History

  • 0.1.0 (2017-05-06) - Initial Release