@pluginjs/emitter
v0.8.9
Published
A workflow for modern frontend development.
Downloads
240
Readme
Emitter
emitter
is a utility JavaScript library for event emitter.
Introduction
Installation
Yarn
yarn add @pluginjs/emitter
NPM
npm i @pluginjs/emitter
Getting Started
CDN:
Development:
<script src="https://unpkg.com/@pluginjs/emitter/dist/emitter.js"></script>
Production:
<script src="https://unpkg.com/@pluginjs/emitter/dist/emitter.min.js"></script>
API
emit
Parameters
| Name | Type | Description | |||-| | event | String | event name | | args | Any[] | args for handler |
Returns
| Name | Type | Description |
|||-|
| Ok | Boolean
| |
on
Parameters
| Name | Type | Description | |||-| | event | String | event name | | listener | Function | handler | | context | Object | this | | priority | Number | priority level |
Returns
| Name | Type | Description |
|||-|
| this | Object
| Instance |
once
Parameters
| Name | Type | Description | |||-| | event | String | event name | | listener | Function | handler | | context | Object | this | | priority | Number | priority level |
Returns
| Name | Type | Description |
|||-|
| this | Object
| Instance |
off
Parameters
| Name | Type | Description | |||-| | event | String | event name | | listener | Function | handler |
Returns
| Name | Type | Description |
|||-|
| this | Object
| Instance |
addListener
Parameters
| Name | Type | Description | |||-| | event | String | event name | | listener | Function | handler | | context | Object | this | | priority | Number | priority level |
Returns
| Name | Type | Description |
|||-|
| this | Object
| Instance |
addListenerOnce
Parameters
| Name | Type | Description | |||-| | event | String | event name | | listener | Function | handler | | context | Object | this | | priority | Number | priority level |
Returns
| Name | Type | Description |
|||-|
| this | Object
| Instance |
removeListener
Parameters
| Name | Type | Description | |||-| | event | String | event name | | listener | Function | handler |
Returns
| Name | Type | Description |
|||-|
| this | Object
| Instance |
removeAllListeners
Parameters
Parameters
| Name | Type | Description | |||-| | event | String | event name |
Returns
| Name | Type | Description |
|||-|
| this | Object
| Instance |
ensureListener
Parameters
| Name | Type | Description | |||-| | listener | Function | handler |
Returns
| Name | Type | Description |
|||-|
| this | Object
| Instance |
hasListeners
Parameters
| Name | Type | Description | |||-| | event | String | event name |
Returns
| Name | Type | Description |
|||-|
| this | Object
| Instance |
getListeners
Parameters
| Name | Type | Description | |||-| | event | String | event name |
Returns
| Name | Type | Description |
|||-|
| listeners | Array
| |
Browser support
Tested on all major browsers.
| IE / Edge | Firefox | Chrome | Safari | Opera | | --------- | --------- | --------- | --------- | --------- | | IE11, Edge| last 2 versions| last 2 versions| last 2 versions| last 2 versions|
License
@pluginjs/emitter is Licensed under the GPL-v3 license.
If you want to use @pluginjs/emitter project to develop commercial sites, themes, projects, and applications, the Commercial license is the appropriate license. With this option, your source code is kept proprietary.
For purchase an Commercial License, contact us [email protected].
Copyright
Copyright (C) 2022 Creation Studio Limited.