https://github.com/lizhengnacl/post-message-im
让通信更简单，支持离线消息
https://github.com/lizhengnacl/post-message-im
browser buffer cache im postmessage
Last synced: about 2 months ago
JSON representation
让通信更简单，支持离线消息
- Host: GitHub
- URL: https://github.com/lizhengnacl/post-message-im
- Owner: lizhengnacl
- License: mit
- Created: 2018-05-31T07:00:10.000Z (about 7 years ago)
- Default Branch: master
- Last Pushed: 2023-03-05T03:50:58.000Z (over 2 years ago)
- Last Synced: 2024-10-13T01:03:16.532Z (8 months ago)
- Topics: browser, buffer, cache, im, postmessage
- Language: JavaScript
- Homepage:
- Size: 2.16 MB
- Stars: 5
- Watchers: 1
- Forks: 1
- Open Issues: 32
-
Metadata Files:
- Readme: README.md
- Changelog: changelog.md
- License: LICENSE
Awesome Lists containing this project
README
[![NPM version][npm-image]][npm-url]
[](https://travis-ci.org/lizhengnacl/post-message-im)
[][npm-url]
> Electron版请参考：[electron-ipc-im](https://github.com/lizhengnacl/electron-ipc-im)，抽象主进程、主窗口、非主窗口，让通信更简单。
## 概述
页面`server`与iframe`client`的通信过程，可以用一种简易的消息模型来理解。
## Feature
* 兼容所有支持ES5语法的浏览器
* 支持离线消息模型
* 平台中立，支持electron
## 安装
```
npm i post-message-im
```
## client 使用
```
import { Client } from 'post-message-im'
const client = new Client({id: 'iframe id'})
client.request({
type: '',
params: {},
callback: (err, res) => {}
})
client.on({
type: '',
callback: (err, res) => {}
})
client.request({
type: 'offline',
callback: (err, res) => {
client.distribute(res);
}
})
```
callback返回值
```
{
rescode: 0, // 0 正确 401 鉴权失败 403 用户未授权 404 协议类型错误，协议过期 408 超时
data: {}
}
```
## server 使用
```
import { Server } from 'post-message-im'
const server = new Server({validator: () => {}})
server.on({
type: '',
callback: (err, res) => {
// get data
server.response(Object.assign({}, res, {data: data}))
}
})
server.response('frameId', server.CONSTANTS.TYPE.SOME_SPECIFIC_TYPE, data)
```
## Promisify
可以选择业界任意一个标准的promisify库，例如：
- bluebird 模块里有 promisify 方法
- es6-promisify 模块
- ThinkJS 里的 promisify 方法
当然，也可以直接使用下面的示例代码
```
let promisify = (fn, receiver = null) => {
return (...args) => {
return new Promise((resolve, reject) => {
fn.apply(receiver, [...args, (err, data) => {
return err? reject(err): resolve(data);
}]);
});
};
};
client.request = promisify(c.request, c);
client.request({
type: '',
}).then((data) => {})
// 显式的callback参数优先级会更高，但不建议这么使用
client.request({
type: '',
callback: (err, data) => {}
}).then((data) => {})
```
[npm-image]: https://img.shields.io/npm/v/post-message-im.svg?style=flat-square
[npm-url]: https://www.npmjs.com/package/post-message-im