KO | EN

GitLite

Minimalist Open Source Repository Search Engine

gitlite — search

#dsh #dsh-plugin #ai-agent #developer-tools #codex #typescript #cli #deepseek-harness #claude-code #ai-agents #mcp #rust

ipc-promise

★ 35 Open GitHub ↗

ipc use as Promises

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# ipc-promise

[![Build Status](https://travis-ci.org/sasaplus1/ipc-promise.svg)](https://travis-ci.org/sasaplus1/ipc-promise)
[![Dependency Status](https://gemnasium.com/sasaplus1/ipc-promise.svg)](https://gemnasium.com/sasaplus1/ipc-promise)
[![NPM version](https://badge.fury.io/js/ipc-promise.svg)](http://badge.fury.io/js/ipc-promise)

ipc use as Promises

## Installation

### npm

```sh
$ npm install ipc-promise
```

## Usage

### main process

```js
var ipcPromise = require('ipc-promise');

ipcPromise.on('twice', function(params) {
  return Promise.resolve(params.value * 2);
});

var electron = require('electron'),
    app = electron.app,
    BrowserWindow = electron.BrowserWindow,
    mainWindow;

app.on('ready', function() {
  mainWindow = new BrowserWindow({});
  mainWindow.loadURL('file://' + __dirname + '/index.html');
});
```

### renderer process

```html
<!DOCTYPE html>
<script src="ipc-promise.min.js"></script>
<script>
  ipcPromise
    .send('twice', {
      value: 1
    })
    .then(function(result) {
      console.log(result);  // => "2"
    });
</script>
```

## Functions

### on(event, listener)

- `event`
  - `String` - event name
- `listener`
  - `Function(*): Promise` - listener function

listen event.

### send(event, data)

- `event`
  - `String` - event name
- `data`
  - `*` - data for send
- `return`
  - `Promise` - Promises

trigger event.

## Test

```sh
$ npm install
$ npm test
```

## License

The MIT license. Please see LICENSE file.

ipc-promise

Explore Similar Repositories

Was this content helpful?

Recent Feedback

Download README