小程序頁面之間的通信利器 - nsevent

這個模塊主要的緣由是用在微信開發時候監聽兩個頁面之間的狀態交互

好比 pageA 和 pageB 兩個頁面, pageA 頁面有收藏項 pageB 也有一樣的收藏項，監聽同一個事件

// 收藏事件改變
nsevent.on('collectChange', () => {
    // 刷新列表數據
})

那麼在 pageA 頁面操做 collect(收藏) 事件會觸發自身頁面 collectChange 回調，這時候nsevent就派上用場，

在 pageA 這樣聲明

// 收藏事件改變
nsevent.on('collectChange', () => {
    // 刷新列表數據
}, 'pageA')

在 pageB 觸發 pageA 的事件，就不會觸發自身頁面的回調了

// 觸發collectChange事件
NSEvent.emit('collectChange', params, { ns: ['pageA'] });

還能夠在 pageC 觸發 pageA, pageB頁面的 collectChange 事件

// 觸發collectChange事件
NSEvent.emit('collectChange', params, { ns: ['pageA', 'pageB'] });

nsevent document

有命名空間的事件監聽器 - event emitter with namespace

安裝和使用

npm i nsevent --save

const nsevent = require('nsevent');

// 瀏覽器
<script src="dist/nsevent.umd.js"></script>

on(eventName, fn, namespace)

參數	必選	說明
eventName	是	監聽事件名
fn	是	回調函數
namespace	否	命名空間

NSEvent.on('add', (a, b) => {
  console.log(a, b);
});

NSEvent.on('add', (a, b) => {
  console.log(a, b, 'ns');
}, 'ns');

// 1, 2
// 1, 2, 'ns'
NSEvent.emit('add', a, b);

once(eventName, fn)

參數	必選	說明
eventName	是	監聽事件名
fn	是	回調函數

NSEvent.once('add', (a, b) => {
  console.log(a, b);
});

NSEvent.emit('add', 1, 2);      // 1, 2
NSEvent.emit('add', 1, 2);      // nothing

emit(eventName, arg1, arg2, ..., object)

參數	必選	說明
eventName	是	監聽事件名
arg[1,2,3...]	否	傳遞給回調函數的值
object	否	{ 最後一個傳遞對象，ns: ['ns'] } 能夠指定命名空間觸發事件

NSEvent.on('fire', () => {
  console.log('fire ns');
}, 'ns');

NSEvent.on('fire', () => {
  console.log('fire ns2');
}, 'ns');

NSEvent.on('fire', () => {
  console.log('fire');
});

NSEvent.emit('fire');     // fire ns, fire ns2, fire
console.log("======");
NSEvent.emit('fire', 1, 2, { ns: [] });     // nothing
NSEvent.emit('fire', 1, 2, { ns: ['ns'] }); // fire ns, fire ns2

off(eventName, [string|function|array])

參數	必選	說明
eventName	是	監聽事件名
string	function	array	否	解綁回調函數
	string	指定命名空間解綁
	function	指定函數解綁
	array	經過數組指定命名空間或者函數解綁

const NSEvent = require('../dist/nsevent.cjs');

NSEvent.on('fire', () => {
  console.log('fire ns');
}, 'ns');

NSEvent.on('fire', () => {
  console.log('fire ns');
}, 'ns');

NSEvent.on('fire', () => {
  console.log('fire1');
}, 'ns1');

NSEvent.emit('fire');   // fire ns, fire ns, fire1
console.log('==========');
NSEvent.off('fire', ['ns']);
NSEvent.emit('fire');   // fire1
console.log('==========');
NSEvent.off('fire', 'ns1');
NSEvent.emit('fire');   // none