1.1.6 • Published 3 years ago

js-events-listener v1.1.6

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

It started as a fork of react-native-event-listeners. Now it is rewritten with Typescript and React Hooks support.

If you use React, check out the simple yet powerful hooks and state management at react.md

API

import GlobalEvent from 'js-events-listener'
// or import { GlobalEvent } from 'js-events-listener'
// or const GlobalEvent = require('js-events-listener');
static methodreturn valuedescription
addEventListenerstring | booleanreturn value is the id of the event listener or false on error
removeEventListenerbooleantrue on success otherwise false
removeAllListenersbooleantrue on success otherwise false
emitEventvoidno return value
onstring | booleanshorthand for addEventListener
rmbooleanshorthand for removeEventListener
rmAllbooleanshorthand for removeAllListeners
emitvoidshorthand for emitEvent

Usage

  • File a.js
  import GlobalEvent from 'js-events-listener'
  export const runThis = () => {
    GlobalEvent.emit('some-event-name', { someData: 123 })
  }
  • File b.js
  import GlobalEvent from 'js-events-listener'
  export const setupListenerBeforeTheEventEmitted = () => {
    GlobalEvent.on('some-event-name', data => {
      console.log(data); // { someData: 123 }
    })
  }
  • File c.js
  import GlobalEvent from 'js-events-listener'
  export const setupListenerBeforeTheEventEmitted = () => {
    const eventId = GlobalEvent.on('some-event-name', data => {
      console.log(data); // { someData: 123 }
    });

    // remove listener
    GlobalEvent.rm(eventId);
  }
  • File d.ts
  import GlobalEvent from 'js-events-listener'

  type PayloadData {
    someData: number,
  }

  export const setupListenerBeforeTheEventEmitted = () => {
    const eventId = GlobalEvent.on<PayloadData>('some-event-name', data => {
      console.log(data); // { someData: 123 }, as PayloadData
    });

    // remove listener
    GlobalEvent.rm(eventId);
  }
1.1.6

3 years ago

1.1.5

3 years ago

1.1.1

3 years ago

1.1.0

3 years ago

1.1.4

3 years ago

1.1.3

3 years ago

1.0.0

7 years ago