Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/sibiraj-s/capillaries
⚡️ Javascript Events and Hooks
https://github.com/sibiraj-s/capillaries
async-events capillaries hooks javascript-events
Last synced: about 8 hours ago
JSON representation
⚡️ Javascript Events and Hooks
- Host: GitHub
- URL: https://github.com/sibiraj-s/capillaries
- Owner: sibiraj-s
- License: mit
- Created: 2019-11-10T14:01:04.000Z (about 5 years ago)
- Default Branch: master
- Last Pushed: 2024-09-24T09:41:44.000Z (4 months ago)
- Last Synced: 2024-12-23T02:36:54.380Z (17 days ago)
- Topics: async-events, capillaries, hooks, javascript-events
- Language: TypeScript
- Homepage: https://npm.im/capillaries
- Size: 1.87 MB
- Stars: 2
- Watchers: 3
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# Capillaries [](https://github.com/sibiraj-s/capillaries/actions)
> Javascript Events and Hooks
## Getting Started
### Installation
Installation can be done via package managers such as [npm] or [yarn]
```bash
% npm install capillaries
# or
% yarn add capillaries
```
### Events
```js
import { Events } from 'capillaries';
const event = new Events();
const listener = function (payload) {
console.log('Event Received:', payload);
};
// create a event listeners
event.on('connecting', listener);
event.on('connected', listener, this); // optionally bind context to the listener when invoked
// listen to all events
event.on('*', (type, payload) => {});
// dispatch events
event.emit('connected', 'paylod');
// remove a event listener
const unsubscribe = event.on('connected', listener);
unsubscribe();
// remove all listeners for given event
event.unbindAll('connected');
// unbind all event listeners
event.unbindAll();
```
### AsyncEvents
```js
import { AsyncEvents } from 'capillaries';
const event = new AsyncEvents();
const handler = async function (payload) {
console.log('Event Received:', payload);
};
// create a event handler
event.on('connected', handler);
// call the event
await event.call('connected', 'paylod');
// remove a event listener
const unsubscribe = event.on('connected', handler);
unsubscribe();
// unbind/remove all events
event.unbindAll();
```
Only one event handler can be attached per event. Attaching more than one event will throw an error.
### Hooks
```js
import { Hooks } from 'capillaries';
const hooks = new Hooks();
// create a tap
hooks.tap('Hook', () => {
return 'Hello World!';
});
hooks.tap('AsyncHook', async () => {
return 'Hello World!';
});
// Call the taps
hooks.call('Hook', payload); //-> returns undefined
hooks.callWaterFall('Hook', payload); //-> returns 'Hello World!'
hooks.callAsync('AsyncHook', payload); // awaits on taps, returns undefined
hooks.callAsyncWaterFall('AsyncHook', payload); // awaits on taps, returns 'Hello World!'
// remove all hooks
hooks.clear();
```
Hooks are executed in order. The calling waterfall hook passes a return value from each function to the next function and returns data from the last tap
### Browser compatibility
- Chrome 38+
- Edge 12+
- Firefox 13+
- Opera 25+
- Safari 8+
- Internet Explorer 11
[npm]: https://www.npmjs.com/
[yarn]: https://yarnpkg.com/lang/en/