From 5ebb3bcb44081a8aacf6223023078433f397ff3e Mon Sep 17 00:00:00 2001 From: bencelaszlo Date: Wed, 2 Oct 2024 19:03:43 +0200 Subject: [PATCH] docs(readme): add clear method documentation Add documention to the new clear method. Update previous docs. --- README.md | 18 ++++++++++++++++++ 1 file changed, 18 insertions(+) diff --git a/README.md b/README.md index 3b63727..bde7f4a 100644 --- a/README.md +++ b/README.md @@ -24,6 +24,8 @@ npm install chiisai-event-emitter ### Subscribe to an Event +Use `EventEmitter.subscribe(eventName, callback)` to subscribe to an event. + ```ts import { EventEmitter } from 'chiisai-event-emitter'; @@ -37,6 +39,8 @@ eventEmitter.emit('event') ### Unsubscibe +`EventEmitter.subscribe(eventName, callback)` method returns a function which can be called to unsubscribe the callback from the event. + ```ts const unsubscibe = eventEmitter.subscribe('event', () => console.log('event-handler called!')); unsubscribe(); @@ -45,6 +49,20 @@ eventEmitter.emit('event') // (nothing happened) ``` +### Delete an Event + +`EventEmitter.clear(eventName)` method removes an event and all callbacks subscibed to this event. + +```ts +eventEmitter.subscribe('event', () => console.log('event-handler called!')); +eventEmitter.subscribe('event', () => console.log('another event-handler called!')); +eventEmitter.clear('event') + +eventEmitter.emit('event') +// (nothing happened) + +``` + [build-img]:https://github.com/bencelaszlo/chiisai-event-emitter/actions/workflows/release.yml/badge.svg [build-url]:https://github.com/bencelaszlo/chiisai-event-emitter/actions/workflows/release.yml [downloads-img]:https://img.shields.io/npm/dt/chiisai-event-emitter