1.0.10 • Published 3 years ago

js-event-listener v1.0.10

Weekly downloads
-
License
ISC
Repository
github
Last release
3 years ago

npm.io

This package suitable for react, react-native or javascript projects. The source written in javascript without any dependencies.

Known Vulnerabilities npm.io npm.io npm.io npm.io npm.io

Why

Certain situations can make our development as difficult like updates the redux state by returning a new state every time which can cause excessive use of memory, pass down in component three the event as a prop or communication between independent components for example can be bypassed with event listener.

Instalation

npm install --save js-event-listener

Usage Example

The event listener also work across different files in react, react-native or javascript apps. All you have to do is import the appropriate function into any file you need and receive or send event. Check Live Example

import React,{ useEffect } from 'react'; 
import { addEventListener, emitEvent, removeEventListener } from 'js-event-listener';

export default function App() {

  useEffect( () => {
    let id = addEventListener("customEvent", (e) => {
      console.log(e);
    });
    return () => {
      removeEventListener(id);
    }
  },[]);

  let clickEventHandler = () => emitEvent("customEvent", "my first event!");

  return (
    <div className="App">
      <button onClick={clickEventHandler}>Event submit</button>
    </div>
  );
}

API Details

// Functions

import { addEventListener, emitEvent, removeEventListener, removeAllEventListener } from 'js-event-listener';

addEventListener(eventName, callback); // create event.
emitEvent(eventType, data); // emit event.
removeEventListener(eventType); // remove spesific event by eventType or id.
removeAllEventListener(); // remove all events.
// Short version

import { on, emit, rm, rmAll } from 'js-event-listener';

on(eventName, callback); // create event.
emit(eventType, data); // emit event.
rm(eventType); // remove spesific event by eventType or id.
rmAll(); // remove all events.

Params.

ParamTypeDescription
eventNameStringA case-sensitive string representing the event type to listen for.
eventTypeString or NumberA case-sensitive string or integer number representing the event to be removed.
callbackFunctionThe funtion what recieve a notification when an event of the specified type occurs.

Functions.

FunctionParamReturnDescription
addEventListenerString AND FunctionIdCreate event.
emitEventString OR NumberNothingFire the event.
removeEventListenerString OR NumberBooleanRemove spesific event by name or id.
removeAllEventListenerNothingNothingRemove all events.
1.0.10

3 years ago

1.0.9

4 years ago

1.0.8

4 years ago

1.0.7

4 years ago

1.0.6

4 years ago

1.0.5

4 years ago

1.0.4

4 years ago

1.0.3

4 years ago

1.0.2

4 years ago

1.0.1

4 years ago

1.0.0

4 years ago