docs: improves docs and types (#2)

Author: ivodolenc

README.md

@@ -17,6 +17,18 @@ A super simple and lightweight event emitter.
 npm i @hypernym/emitter
 ```
 
+## Imports
+
+```js
+// CJS
+const { createEmitter } = require('@hypernym/emitter')
+```
+
+```js
+// ESM & TS
+import { createEmitter } from '@hypernym/emitter'
+```
+
 ## Usage
 
 ### JS
@@ -52,18 +64,58 @@ emitter.emit('event-id', { x: 0, y: 0 })
 
 ### .on()
 
+Registers a specific event.
+
 ```ts
 emitter.on(id: string, callback: (event: any) => void)
 ```
 
 ### .emit()
 
+Emits a specific event.
+
 ```ts
 emitter.emit(id: string, event: any)
 ```
 
+### .events
+
+Main events map.
+
+Stores all registered events.
+
+```ts
+emitter.events
+```
+
+### .has()
+
+Checks if a specific event by `id` exists in the map.
+
+```ts
+emitter.events.has(id: string)
+```
+
+### .get()
+
+Gets a specific event by `id` from the map.
+
+```ts
+emitter.events.get(id: string)
+```
+
+### .delete()
+
+Deletes a specific event by `id` from the map.
+
+```ts
+emitter.events.delete(id: string)
+```
+
 ### .clear()
 
+Removes all events from the map.
+
 ```ts
 emitter.events.clear()
 ```

playground/src/main.ts

@@ -8,8 +8,16 @@ type Events = {
 
 const emitter: Emitter<Events> = createEmitter<Events>()
 
-emitter.on('event-id', e => console.log(e.x, e.y))
+emitter.on('event-id', e => console.log(e.x, e.y)) // 0 0
 
 emitter.emit('event-id', { x: 0, y: 0 })
 
-console.log(emitter.events)
+console.log(emitter.events) // Map(1) {'event-id' => Array(1)}
+
+const eventId = emitter.events.get('event-id')
+
+console.log(eventId?.toString()) // (e) => console.log(e.x, e.y)
+
+if (emitter.events.has('event-id')) emitter.events.delete('event-id')
+
+console.log(emitter.events) // Map(0) {size: 0}

src/emitter.ts

@@ -2,6 +2,23 @@ import type { EventsMap, Emitter } from './types'
 
 /**
  * Creates an event emitter.
+ *
+ * @example
+ *
+ * ```ts
+ * import { createEmitter, Emitter } from '@hypernym/emitter'
+ *
+ * type Events = {
+ *   'event-id': { x: number; y: number }
+ *   // ...
+ * }
+ *
+ * const emitter: Emitter<Events> = createEmitter<Events>()
+ *
+ * emitter.on('event-id', e => console.log(e.x, e.y))
+ *
+ * emitter.emit('event-id', { x: 0, y: 0 })
+ * ```
  */
 export function createEmitter<Events extends EventsMap>(): Emitter<Events> {
   const events = new Map<keyof Events, Array<(event: any) => void>>()

src/types.ts

@@ -5,7 +5,36 @@ export interface EventsMap {
 }
 
 export interface Emitter<Events extends EventsMap> {
+  /**
+   * Main events map.
+   *
+   * Stores all registered events.
+   *
+   * @example
+   *
+   * ```ts
+   * emitter.events
+   * ```
+   */
   events: Map<keyof Events, Array<(event: any) => void>>
+  /**
+   * Registers a specific event.
+   *
+   * @example
+   *
+   * ```ts
+   * emitter.on('event-id', e => console.log(e.x, e.y))
+   * ```
+   */
   on<K extends keyof Events>(id: K, callback: (event: Events[K]) => void): void
+  /**
+   * Emits a specific event.
+   *
+   * @example
+   *
+   * ```ts
+   * emitter.emit('event-id', { x: 0, y: 0 })
+   * ```
+   */
   emit<K extends keyof Events>(id: K, event: Events[K]): void
 }