A small yet beautiful PubSub library, implementing the Publisher-Subscriber pattern.
npm install @jsmini/pubsub
A small yet beautiful PubSub library, implementing the Publisher-Subscriber pattern.
English | 简体中文
unit test ensure it supports the following environments.
| IE/Edge | Chrome | Firefox | Safari | Opera | IOS | Android | Node |
| ------- | ------ | ------- | ------ | ----- | --- | ------- | ----- |
| 6+ | 23+ | 4+ | 6+ | 10+ | 5+ | 2.3+ | 0.10+ |
Notice: builds depends on ES5. In order to support IE6-8, you should import es5-shim . See example in demo/demo-global.html
``
.
├── demo
├── dist # production code
├── doc # document
├── src # source code
├── test # unit test
├── CHANGELOG.md
└── TODO.md
npm installation
`bash`
$ npm install --save @jsmini/pubsub
Node.js
`js`
var name = require('@jsmini/pubsub').name;
webpack
`js`
import { name } from '@jsmini/pubsub';
Require.js
`js`
requirejs(
['node_modules/@jsmini/pubsub/dist/index.aio.js'],
function (jsmini_pubsub) {
var name = jsmini_pubsub.name;
},
);
Browser
`html
`
when initialize, install dependencies
`bash`
$ npm install
builds your code for production to build folder
`bash`
$ npm run build
run unit test. notice: borwser enviroment need to test manually. test file is in test/browser
`bash`
$ npm test
change the version in package.json and README.md, add your description in CHANGELOG.md, and then release it happily.
`bash`
$ npm run release
publish the new package to npm
`bash`
$ npm publish --access=public
rename project. you need to edit project name when initialize project or anytime you want to rename the project . you need to rename formName and toname in file rename.js,which will automatically rename project name in the following files
- README.md
- package.json
- config/rollup.js
- test/browser/index.html
`bash``
$ npm run rename # rename command