# @xroom.app/events

> Wrapper over standard nodejs events

Latest version **1.0.2** (published 2021-04-21) · MIT license · 0 weekly downloads

## Install

```sh
npm install @xroom.app/events
pnpm add @xroom.app/events
yarn add @xroom.app/events
bun add @xroom.app/events
```

## Health

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

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.2 |
| Published | 2021-04-21 |
| First published | 2020-12-12 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 7.7 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | awerlogus |
| Maintainers | xroom.app |
| Keywords | nodejs, events, wrapper, xroom.app |

## Links

- npm: https://www.npmjs.com/package/@xroom.app/events
- Repository: https://github.com/xroom-app/public-packages
- Homepage: https://github.com/xroom-app/public-packages/tree/master/packages/events/#readme
- Issues: https://github.com/xroom-app/public-packages/issues
- npm.io page: https://npm.io/package/@xroom.app/events

## Alternatives

- [async-exit-hook](https://npm.io/package/async-exit-hook.md) — 3.7M weekly downloads
- [evnty](https://npm.io/package/evnty.md) — 7.2K weekly downloads
- [eleventy-plugin-asciidoc](https://npm.io/package/eleventy-plugin-asciidoc.md) — 3.5K weekly downloads
- [@jswork/next-get2get](https://npm.io/package/@jswork/next-get2get.md) — 945 weekly downloads
- [@dashersw/axon](https://npm.io/package/@dashersw/axon.md) — 934 weekly downloads

## Recent versions

- 1.0.2 (latest) — 2021-04-21
- 1.0.1 — 2020-12-22
- 1.0.0 — 2020-12-12

## README

# Wrapper over standard nodejs events

## This package is deprecated and will be deleted soon

Use [events2](https://github.com/xroom-app/public-packages/tree/master/packages/events2) package instead

## Installation

Run from command line

```
npm i @xroom.app/events
```

## Usage example

```js
const { createEvent, createEventSystem } = require('@xroom.app/events')

/**
 * @template T
 *
 * @typedef {import('@xroom.app/events').Event<T>} Event
 */

const events = {
    /** @type {Event<{ roomId: string, options: Record<string, any> }>} */
    roomCreated: createEvent(),
    /** @type {Event<{ roomId: string }>} */
    roomRemoved: createEvent(),
}

const eventSystem = createEventSystem(Object.values(events))

eventSystem.on(events.roomCreated, ({ roomId }) => console.log(`Created a room with id ${roomId}`))
eventSystem.on(events.roomRemoved, ({ roomId }) => console.log(`Removed a room with id ${roomId}`))

eventSystem.emit(events.roomCreated, { roomId: 'foobar', options: {} })
eventSystem.emit(events.roomRemoved, { roomId: 'foobar' })
```

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