@fickou/adonis-server-sent-event
Advanced tools
An addon/plugin package to provide server-sent events functionality for AdonisJS 5.0+
An addon/plugin package to provide server-sent events functionality for AdonisJS 5.0+
adonis install adonis-server-sent-events --save
Firstly, follow the instructions in
instructions.mdfile to setup the Provider and Middleware
See the instructions.md file for the complete installation steps and follow as stated.
Install provider:
node ace configure adonis-server-sent-events
Like any other provider, you need to register the provider inside .adonisrc.json file.
{
"providers": [
...,
"adonis-sent-events/providers/ServerSentEventsProvider",
]
}
Register the following middleware inside start/kernel.ts file.
Server.middleware.register([
() => import('@ioc:Adonis/Middleware/EventSourceWatcher'),
])
Or alternatively setup the middleware as a named (use any name you feel like) middleware inside
start/kernel.tsfile.
Server.middleware.registerNamed({
eventsource: () => import('@ioc:Adonis/Middleware/EventSourceWatcher'),
})
HINT: It would be much easier and better to make the EventSourceWatcher middleware a global middleware
Setup serve-sent events route inside
start/routes.tsfile.
import Route from '@ioc:Adonis/Core/Route'
/**
* If the 'eventsource' named middleware is set
* then setup route like below
*/
Route.get('/stream', ({ source }) => {
// send a server-sent events comment
source.send("Hello AdonisJS", '!This is a comment!');
}).middleware(['eventsource']);
/**
* If the middleware is a global middlware
* then setup route like below
*/
Route.get('/stream', ({ source }) => {
// send a server-sent events comment
source.send("Hello AdonisJS", '!This is a comment!');
})
Route.post('/send/email', 'NotificationsController.sendEmail')
Setup a controller to dispatch server-sent events to the browser using the
source.send(data: Object, comment: String, event: String, retry: Number)method like so:
import Mail from "@ioc:Adonis/Addons/Mail";
export default class NotificationsController {
async sendEmail ({ request, auth, source }){
let input = request.only([
'ticket_user_id'
]);
let { id, email, fullname } = await auth.getUser();
let error = false
try{
await Mail.send(
'emails.template',
{ fullname }, (message) => {
message.to(email)
message.from('crm.tickets@funsignals.co')
message.subject('Ticket Creation Job Status')
})
}catch(err){
error = true
}finally{
source.send({
ticket_reciever: id,
ticket_creator: input.ticket_user_id,
ticket_mail_status: `email sent ${error ? 'un' : ''}successfuly`
}, null, 'update', 4000) // event: 'update', retry: 4000 (4 seconds)
}
}
}
/**
* source.send (METHOD)
*/
send( data: object, comment: string, event: string, retry: number );
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<!-- Polyfill for older browsers without native support for the HTML5 EventSource API. -->
<script src="https://cdn.polyfill.io/v2/polyfill.min.js?features=EventSource"></script>
</head>
<body>
<script id="server-side-events" type="text/javascript">
const stream = new EventSource("http://127.0.0.1:3333/stream");
stream.addEventListener('message', function(e){
console.log("Data: ", e.data);
}, false);
stream.addEventListener('open', function(e) {
// Connection was opened.
console.log('connection open: true');
}, false);
stream.addEventListener('error', function(e) {
if (e.readyState == EventSource.CLOSED) {
// Connection was closed.
console.log('connection closed: true');
}
}, false);
</script>
</body>
</html>
MIT
npm i
npm run lint
npm run test
See the CONTRIBUTING.md file for info
My Facebook Facebook Page.
FAQs
An addon/plugin package to provide server-sent events functionality for AdonisJS 5.0+
We found that @fickou/adonis-server-sent-event demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Ruby Central’s incident report on the RubyGems.org access dispute sparks backlash from former maintainers and renewed debate over project governance.
Research
/Security News
Socket researchers uncover how threat actors weaponize Discord across the npm, PyPI, and RubyGems ecosystems to exfiltrate sensitive data.
Security News
Socket now integrates with Bun 1.3’s Security Scanner API to block risky packages at install time and enforce your organization’s policies in local dev and CI.