@edraghiciu-vks/jquery-pubsub
v1.0.0
Published
jQuery Publish/Subscribe - A global event bus to decouple event senders from receivers - VKS package
Maintainers
Readme
edraghiciu-vks-jquery-pubsub
jQuery Publish/Subscribe - A global event bus to decouple event senders from receivers.
This is a VKS-specific package providing a publish/subscribe pattern for jQuery.
Installation
npm install edraghiciu-vks-jquery-pubsubUsage
import 'edraghiciu-vks-jquery-pubsub';
import $ from 'jquery';
// Subscribe to an event
$(window).subscribe('my-event', (ev, data) => {
console.log('Event received:', data);
});
// Publish an event
$(window).publish('my-event', { message: 'Hello!' });
// Unsubscribe from an event
$(window).unsubscribe('my-event');
// Subscribe to multiple events
$(window).subscribe({
'event1': callback1,
'event2': callback2
});
// Unsubscribe from all events with a namespace
$(window).unsubscribe('.namespace');API
Methods
subscribe(event, callback)- Register an observer for the given eventsubscribe(eventsObject)- Register multiple observers at oncepublish(event, data)- Broadcast an event to all registered observersunsubscribe(event)- Remove an observer for the given eventunsubscribe()- Remove all observers
Features
- Global event bus pattern
- Namespace support for event management
- Decouples event senders from receivers
- Works with any jQuery object, typically used with
$(window)
License
MIT
Copyright
Copyright (c) 2010-2015 Visual Knowledge Share Ltd, All rights reserved.
