# EventEmitter

This module, in particular, offers the EventEmitter class, which we'll use to handle our events.
```js
import { EventEmitter } from 'sp-editor/event-emitter';
// For example, let's create a start event, and as a matter of providing a sample,
// we react to that by just logging to the console:
const eventEmitter = new EventEmitter()

eventEmitter.on('start', () => {
  console.log('started')
})

// When we run
eventEmitter.emit('start')
// the event handler function is triggered, and we get the console log.
```

## Methods

### destroyEventEmitter()

remove all listeners for an event.

- @returns `void`

### emit(eventName, arg1, arg2, ..., argN)

`emit` is used to trigger an event.

Param|Types|Required|Description
:--|:--:|:--:|:--
eventName|`string`|yes|-
args|`any`|yes|-

- @returns `EventEmitter`

### off(eventName, fn)

remove an event listener from an event.

Param|Types|Required|Description
:--|:--:|:--:|:--
eventName|`string`|yes|custom event name.
fn|`Function`|no|callback function. When `fn` is not a function, all monitoring functions of `eventName` will be removed.

- @returns `EventEmitter`

### on(eventName, fn)

`on` is used to add a callback function that's going to be executed when the event is triggered.

Param|Types|Required|Description
:--|:--:|:--:|:--
eventName|`string`|yes|custom event name.
fn|`Function`|yes|callback function.

- @returns `EventEmitter`

### once(eventName, fn)

`once` add a one-time listener.

Param|Types|Required|Description
:--|:--:|:--:|:--
eventName|`string`|yes|custom event name.
fn|`Function`|yes|callback function.

- @returns `EventEmitter`

## Types

### EventEmitterCallback

```ts
type EventEmitterCallback = (...args: any[]) => void
```

## Other Docs

Docs|Description|Url
:--|:--|:--
Editor|class Editor documentation, main module of SpEditor.|[/docs/Editor.md](./Editor.md)
EventEmitter|class EventEmitter documentation.|[/docs/EventEmitter.md](./EventEmitter.md)
SpEditor|class SpEditor documentation.|[/docs/SpEditor.md](./SpEditor.md)
nodejs-helpers|nodejs-helpers documentation.|[/docs/nodejs-helpers.md](./nodejs-helpers.md)
Others|Other documentations.|[/docs](./)

## License

MIT License © 2018-Present [Capricorncd](https://github.com/capricorncd).