simple-custom-event
Advanced tools
Simple and easy to use custom event implementation with optional
EventTarget element.
EventTarget is not requiredyarn add simple-custom-event
npm install simple-custom-event
<script src="//unpkg.com/simple-custom-event@1.0.1"></script>
Sample of usage where we are creating MY_CUSTOM_EVENT event and triggering it with some optional data.
after Yarn/NPM installation
import SimpleCustomEvent from 'simple-custom-event'
const myEvents = new SimpleCustomEvent()
myEvents.on('MY_CUSTOM_EVENT', (data) => {
console.log(data.detail)
})
myEvents.trigger('MY_CUSTOM_EVENT', {myOptionalData: 'eg some string'})
after Yarn/NPM installation
import SimpleCustomEvent from 'simple-custom-event'
const myEvents = new SimpleCustomEvent()
myEvents.on('MY_CUSTOM_EVENT', (data: CustomEvent) => {
console.log(data.detail)
})
myEvents.trigger('MY_CUSTOM_EVENT', {myOptionalData: 'eg some string'})
with CDN
<!doctype html>
<html lang="en">
<head>
<title>Simple Custom Event</title>
</head>
<body>
<script src="//unpkg.com/simple-custom-event@1.0.1"></script>
<script>
var myEvents = new SimpleCustomEvent()
myEvents.on('MY_CUSTOM_EVENT', function(data) {
console.log(data.detail)
})
myEvents.trigger('MY_CUSTOM_EVENT', {myOptionalData: 'eg some string'})
</script>
</body>
</html>
Events simplifies the communication between components of application. Decouples event senders and receivers.
Below simple example with multi instances of SimpleCustomEvent class:
file-1.js (ES6):
import SimpleCustomEvent from 'simple-custom-event'
const myEvtListener = new SimpleCustomEvent()
myEvtListener.on('MY_CUSTOM_EVENT', () => {
// do something...
})
file-2.js (ES6):
import SimpleCustomEvent from 'simple-custom-event'
const myEvtEmiter = new SimpleCustomEvent()
myEvtEmiter.trigger('MY_CUSTOM_EVENT')
All available, public methods of SimpleCustomEvent class:
constructor([target])
Initializes an object.
target .trigger(eventName[, detail])
Initializes and dispatches an custom Event, invoking the affected Listeners.
.on(eventName, callback)
Sets up a function that will be called whenever the specified event is triggered.
eventName callback .off(eventName)
Removes an event listener previously registered with .on().
eventName Can you improve this simple project? Feel free to join it! Source code is TypeScript.
# project setup
yarn install
# compiles for development
yarn dev
# or
yarn dev:watch
# run unit tests
yarn test
Code released under the MIT license.
FAQs
Simple custom event implementation, with polyfill
The npm package simple-custom-event receives a total of 2 weekly downloads. As such, simple-custom-event popularity was classified as not popular.
We found that simple-custom-event demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
In this segment of the Risky Business podcast, Feross Aboukhadijeh and Patrick Gray discuss the challenges of tracking malware discovered in open source softare.
Research
Security News
A threat actor's playbook for exploiting the npm ecosystem was exposed on the dark web, detailing how to build a blockchain-powered botnet.
Security News
NVD’s backlog surpasses 20,000 CVEs as analysis slows and NIST announces new system updates to address ongoing delays.