{"id":20655570,"url":"https://github.com/lizhengnacl/post-message-im","last_synced_at":"2025-04-19T12:07:06.916Z","repository":{"id":32499698,"uuid":"135545135","full_name":"lizhengnacl/post-message-im","owner":"lizhengnacl","description":"让通信更简单，支持离线消息","archived":false,"fork":false,"pushed_at":"2023-03-05T03:50:58.000Z","size":2270,"stargazers_count":5,"open_issues_count":32,"forks_count":1,"subscribers_count":1,"default_branch":"master","last_synced_at":"2024-10-13T01:03:16.532Z","etag":null,"topics":["browser","buffer","cache","im","postmessage"],"latest_commit_sha":null,"homepage":"","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/lizhengnacl.png","metadata":{"files":{"readme":"README.md","changelog":"changelog.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2018-05-31T07:00:10.000Z","updated_at":"2023-10-27T02:00:29.000Z","dependencies_parsed_at":"2023-01-14T21:25:21.457Z","dependency_job_id":null,"html_url":"https://github.com/lizhengnacl/post-message-im","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/lizhengnacl%2Fpost-message-im","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/lizhengnacl%2Fpost-message-im/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/lizhengnacl%2Fpost-message-im/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/lizhengnacl%2Fpost-message-im/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/lizhengnacl","download_url":"https://codeload.github.com/lizhengnacl/post-message-im/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":224951678,"owners_count":17397425,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["browser","buffer","cache","im","postmessage"],"created_at":"2024-11-16T18:11:51.985Z","updated_at":"2024-11-16T18:11:52.490Z","avatar_url":"https://github.com/lizhengnacl.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"[![NPM version][npm-image]][npm-url]\n[![Build Status](https://travis-ci.org/lizhengnacl/post-message-im.svg?branch=master)](https://travis-ci.org/lizhengnacl/post-message-im)\n[![npm downloads](https://img.shields.io/npm/dm/post-message-im.svg?style=flat-square)][npm-url]\n\n\u003e Electron版请参考：[electron-ipc-im](https://github.com/lizhengnacl/electron-ipc-im)，抽象主进程、主窗口、非主窗口，让通信更简单。\n\n## 概述\n页面`server`与iframe`client`的通信过程，可以用一种简易的消息模型来理解。\n\n## Feature\n* 兼容所有支持ES5语法的浏览器\n* 支持离线消息模型\n* 平台中立，支持electron\n\n## 安装\n\n```\nnpm i post-message-im\n```\n\n## client 使用\n\n```\nimport { Client } from 'post-message-im'\n\nconst client = new Client({id: 'iframe id'})\n\nclient.request({\n    type: '',\n    params: {},\n    callback: (err, res) =\u003e {}\n})\n\nclient.on({\n    type: '',\n    callback: (err, res) =\u003e {}\n})\n\nclient.request({\n    type: 'offline',\n    callback: (err, res) =\u003e {\n        client.distribute(res);\n    }\n})\n```\n\ncallback返回值\n\n```\n{\n    rescode: 0, // 0 正确 401 鉴权失败 403 用户未授权 404 协议类型错误，协议过期 408 超时\n    data: {}\n}\n```\n\n##  server 使用\n\n```\nimport { Server } from 'post-message-im'\n\nconst server = new Server({validator: () =\u003e {}})\n\nserver.on({\n    type: '',\n    callback: (err, res) =\u003e {\n        // get data\n        server.response(Object.assign({}, res, {data: data}))\n    }\n})\n\nserver.response('frameId', server.CONSTANTS.TYPE.SOME_SPECIFIC_TYPE, data)\n```\n\n##  Promisify\n\n可以选择业界任意一个标准的promisify库，例如：\n- bluebird 模块里有 promisify 方法\n- es6-promisify 模块\n- ThinkJS 里的 promisify 方法\n\n当然，也可以直接使用下面的示例代码\n```\nlet promisify = (fn, receiver = null) =\u003e {\n    return (...args) =\u003e {\n        return new Promise((resolve, reject) =\u003e {\n            fn.apply(receiver, [...args, (err, data) =\u003e {\n                return err? reject(err): resolve(data);\n            }]);\n        });\n    };\n};\n\nclient.request = promisify(c.request, c);\n\nclient.request({\n    type: '',\n}).then((data) =\u003e {})\n\n// 显式的callback参数优先级会更高，但不建议这么使用\nclient.request({\n    type: '',\n    callback: (err, data) =\u003e {}\n}).then((data) =\u003e {})\n```\n\n\n[npm-image]: https://img.shields.io/npm/v/post-message-im.svg?style=flat-square\n[npm-url]: https://www.npmjs.com/package/post-message-im\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Flizhengnacl%2Fpost-message-im","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Flizhengnacl%2Fpost-message-im","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Flizhengnacl%2Fpost-message-im/lists"}