adonisjs-sse

adonis-sse

An addon/plugin package to provide server-sent events functionality for AdonisJS 4.0+

Getting Started

    adonis install adonisjs-sse

Usage

Setup serve-sent events route inside start/routes.js file.

/** @type {typeof import('@adonisjs/framework/src/Route/Manager')} */
const Route = use('Route');

Route.get('/stream', ({ source }) => {
      // send a server-sent events comment
      source.send(null, '!This is a comment!');
})//.middleware(['eventsource']);

Route.post('/send/email', 'NotificationsController.sendEmail')

Installation Instructions

See the instructions.md file for the complete installation steps and follow as stated.

HINT: It would be much easier and better to make the EventSourceWatcher middleware a global middleware

Example(s)

Setup a controller to dispatch server-sent events to the browser using the source.send() method like so:

/** @type {typeof import('@adonisjs/mail/src/Mail')} */
const Mail = use('Mail')

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('[e-mail]') 
				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')
			
        }
    }
}

module.exports = NotificationsController		

License

MIT

Running Tests

    npm i

    npm run lint
    
    npm run test

Credits

• Ifeora Okechukwu

Contributing

See the CONTRIBUTING.md file for info

Support

Coolcodes is a non-profit software foundation (collective) created by Oparand - parent company of StitchNG, Synergixe based in Abuja, Nigeria. You'll find an overview of all our work and supported open source projects on our Facebook Page.

Follow us on facebook if you can to get the latest open source software/freeware news and infomation.

Does your business depend on our open projects? Reach out and support us on Patreon. All pledges will be dedicated to allocating workforce on maintenance and new awesome stuff.

Changelog

0.1.1 (2019-10-22)

Initial Release

Bug Fixes

• None