# typed-ts-events

> Typed events for typescript

Latest version **3.0.1** (published 2024-07-10) · ISC license · 0 weekly downloads

## Install

```sh
npm install typed-ts-events
pnpm add typed-ts-events
yarn add typed-ts-events
bun add typed-ts-events
```

## Health

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

Positive: has types; no vulnerabilities; high quality score.

Warnings: low downloads; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 3.0.1 |
| Published | 2024-07-10 |
| First published | 2019-02-17 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 52.5 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 2 |
| Author | tsddaniil@gmail.com |
| Maintainers | tsigel |
| Keywords | typed, events, typescript, eventemitter |

## Links

- npm: https://www.npmjs.com/package/typed-ts-events
- Repository: https://github.com/tsigel/typed-ts-events
- Homepage: https://github.com/tsigel/typed-events#readme
- Issues: https://github.com/tsigel/typed-events/issues
- npm.io page: https://npm.io/package/typed-ts-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

- 3.0.1 (latest) — 2024-07-10
- 3.0.0 — 2024-07-05
- 2.1.2 — 2024-03-28
- 2.1.0 — 2024-03-25
- 2.0.0 — 2024-03-25
- 1.2.1 — 2020-12-08
- 1.2.0 — 2020-10-17
- 1.1.2 — 2020-10-14
- 1.1.1 — 2019-10-08
- 1.1.0 — 2019-10-08
- 1.0.5 — 2019-02-17
- 1.0.4 — 2019-02-17
- 1.0.3 — 2019-02-17
- 1.0.2 — 2019-02-17
- 1.0.1 — 2019-02-17
- … 1 more at https://npm.io/package/typed-ts-events/versions

## README

[![Coverage Status](https://coveralls.io/repos/github/tsigel/typed-ts-events/badge.svg)](https://coveralls.io/github/tsigel/typed-ts-events)

# Typed Events 

Библиотека для работы с типизированными событиями в TypeScript и javascript.

---

### Установка

```bash
npm i typed-ts-events --save
```

## EventEmitter

### on

+ eventName - наименование события на которе подписываемся
+ handler - обработчик события

Подписываемся на событие. 

```typescript
import { EventEmitter } from 'typed-ts-events';


const emitter = new EventEmitter<{test: number}>();

emitter.on('test', (data: number) => {
    ...
});

```

### once

Идентичен `on` но после первого вызова события автоматически отпишется.

### off
Позволяет отписаться от событий.

Параметры:
+ [eventName] - имя события. Если не передано отпишется от всех событий с переданным `handler`.  
+ [handler] - обработчик событий. Если не передан - отпишется от всех обработчиков с данным `eventName`.

Если параметры не переданы - отпишется от всех событий.

Пример:
```typescript
   emitter.off('some-event', handler); // Отпишется от `some-event` с обработчиком `handler`
   emitter.off('some-event'); // Отпишется от всех обработчиков на имя `some-event`
   emitter.off(null, handler); // Отпишется во всех именах от обработчика `handler`
   emitter.off(handler); // Отпишется во всех именах от обработчика `handler`
   emitter.off(); // Отпишется от всех событий
```

### trigger 
Запускает событие.

Параметры:
+ eventName - имя запускаемого события
+ data - данные которые будут переданы в обработчики событий

Пример:
```typescript
import { EventEmitter } from 'typed-ts-events';


const emitter = new EventEmitter<{test: number}>();

emitter.on('test', (data: number) => {
    ...
});

emitter.trigger('test', 111);
```

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