# electron-requester

> 方便ipcRenderer与ipcMain通信

Latest version **1.0.3** (published 2019-05-10) · ISC license · 0 weekly downloads

## Install

```sh
npm install electron-requester
pnpm add electron-requester
yarn add electron-requester
bun add electron-requester
```

## Health

**Score 25/100 (F)** — status: abandoned.

Positive: has types; no vulnerabilities; high quality score.

Warnings: low downloads; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.3 |
| Published | 2019-05-10 |
| First published | 2019-05-10 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 16.3 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | Charles He |
| Maintainers | tao1428 |
| Keywords | electron |

## Links

- npm: https://www.npmjs.com/package/electron-requester
- Repository: https://github.com/taotao1428/electron-requester
- Homepage: https://github.com/taotao1428/electron-requester#readme
- Issues: https://github.com/taotao1428/electron-requester/issues
- npm.io page: https://npm.io/package/electron-requester

## Recent versions

- 1.0.3 (latest) — 2019-05-10
- 1.0.2 — 2019-05-10
- 1.0.1 — 2019-05-10
- 1.0.0 — 2019-05-10

## README

# electron-requester
用于electron中ipcRenderer与ipcMain通信。electron提供的api是事件的发送与监听，但是这种模式在开发的过程中并不方便。所以我将这些接口封装成服务端与客户端的形式，ipcRenderer为客户端，ipcMain作为服务端。

## Requester
提供给ipcRenderer使用，用于请求ipcMain。有一个实现类`DefaultRequester`

```typescript
export interface Requester {
  /**
   * 发送请求
   * @param channel             通道。注意这不会ipcRenderer.send(channel, listener)中的通道，仅是一个参数
   * @param params              参数
   * @param handler             处理最后结果的handler
   * @param progressiveHandler  处理过程通知的handler
   */
  request(channel: string,
          params: {[key: string]: any},
          handler: EndHandler,
          progressiveHandler?: ProgressiveHandler);
}
```


## Dispatcher
提供给ipcMain使用，用于监听ipcRenderer发送的请求。有一个实现类`DefaultDispatcher`

```typescript
/**
 * 事件调度器
 */
export interface Dispatcher {
    dispatch(): void;
}
```

## HandlerRegistry
用于注册处理器，有一个实现类`DefaultHandlerRegistry`
```typescript
/**
 * handler注册器
 */
export interface HandlerRegistry {
    /**
     * 注册handler
     * @param channel 事件
     * @param handler 处理器
     */
    register(channel: string, handler: ChannelHandler): this;

    /**
     * 获得handler
     */
    getHandler(channel: string): ChannelHandler;
}
```
## ChannelHandler
用于处理请求，有一个实现类`EchoChannelHandler`
```typescript
/**
 * 处理事件
 */
export interface ChannelHandler {
  /**
   * 处理事件
   * @param responser
   * @param param
   */
  handle(responser: Responser, param: {[key: string]: any});
}
```

---
_Source: https://npm.io/package/electron-requester · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._
