# nsevent

> > 有命名空间的事件监听器 - event emitter with namespace

Latest version **0.0.2** (published 2018-11-22) · 0 weekly downloads

## Install

```sh
npm install nsevent
pnpm add nsevent
yarn add nsevent
bun add nsevent
```

## Health

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

Positive: esm support; no vulnerabilities.

Warnings: low downloads; no types; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.0.2 |
| Published | 2018-11-22 |
| First published | 2018-11-21 |
| Weekly downloads | 0 |
| TypeScript types | none |
| Module format | ESM + CommonJS |
| Dependencies | 1 |
| Unpacked size | 16.9 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 2 |
| Author | kelen |
| Maintainers | imkelen |

## Links

- npm: https://www.npmjs.com/package/nsevent
- Repository: https://github.com/KELEN/nsevent
- Homepage: https://github.com/KELEN/nsevent#readme
- Issues: https://github.com/KELEN/nsevent/issues
- npm.io page: https://npm.io/package/nsevent

## Dependencies (1)

- [ms](https://npm.io/package/ms.md) ^2.0.0

## Recent versions

- 0.0.2 (latest) — 2018-11-22
- 0.0.1 — 2018-11-21

## README

# nsevent

> 有命名空间的事件监听器 - event emitter with namespace

## on(eventName, fn, namespace)

| 参数 | 必选 | 说明 |
| -- | -- | -- |
| eventName | 是 | 监听事件名 |
| fn | 是 | 回调函数 |
| namespace | 否 | 命名空间 |

```javascript
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 | 是 | 回调函数 |

```javascript
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'] } 可以指定命名空间触发事件 |

```javascript
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 | 通过数组指定命名空间或者函数解绑 |

```javascript
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
```

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