That is a module for real-time event-based APIs.
npm install --save eventfy
- On Server-Side
const EventFy = require('eventfy');
const Eventfy = new EventFy();
// the pointer is set and I used the same name
// to his socket
Eventfy.pointer('/user', user => {
// user gains the EventEmitter powers,
// because he is the socket
user.on('publish', data => {
console.log(data.title);
});
});
// same thing but with other pointer
// note that pointers are similar to endpoints RESTful
Eventfy.pointer('/admin', admin => {
admin.on('check', data => {
console.log(data.users);
});
});He come with a default port 8080 that will turn on the server and require the Socket.io module.
opts.useExpress Boolean
opts.app Express Application
const EventFy = require('eventfy');
const Eventfy = new EventFy();
// with Express application
const EventFy = require('eventfy');
const express = require('express');
const app = express();
// pass the port first
// and follow, pass an Object for config
// with the keys useExpress and app
const Eventfy = new EventFy(8080, {
useExpress: true,
app: app
});
That will create a socket.io's namespace, like a endpoint GET /user/profile but, with pointer is needed only a .pointer() which is created a 'endpoint' where you will create your events. Check the example.
// pointerName callback
Eventfy.pointer('/admin', admin => {
// here will stay your events
//...
});
-
Socket.io - featuring the fastest and most reliable real-time engine
-
Canva - Logo made by canva.com
-
Object Encrypter - Encrypt/decrypt javascript objects as base64 strings with optional TTL support
Please read CONTRIBUTING.md for details on our code of conduct, and the process for submitting pull requests to me.
- Vítor Roque - Initial work - Roqueando
See also the list of contributors who participated in this project.
This project is licensed under the MIT License - see the LICENSE.md file for details
- Endpoints as Event Points
- WebSocket
- A more faster and event-based API