Neolithic Populous Metropolis

    endpoint-wrapper.io

    0.0.15 • Public • Published

    endpoint-wrapper.io - socket emitting everywhere!

    endpoint.io is express middleware that wraps around socket.io, which manages the socket object as a singleton, and exposes it

    This packages requires you to install and manage socket.io separately, and pass it to this package. If you would rather socket.io be fully abstracted and managaged, use endpoint.io instead.

    Usage (high-level)

    Invoke endpoint-wrapper, passing the socket.io package as the first argument, and http as the second. This must be done before using inject, so add it near the top of your file, ususally app.js

    let http = require('http');
    let socketio = require('socket.io');
    let io = require('endpoint-wrapper.io')(socketio, http); // socket.io should NOT be invoked here.
    // `io` is the same object socket.io returns.

    You can then inject io into express middleware in any files (even seperate route files), and gain access to it via res

     
    let { inject } = require('endpoint.io');
     
     
    router.post('/notify', inject, (req, res) => {
     
        res.io.emit('event-from-endpoint', ...req.body);
     
        res.status(200).send('data emitted via socket');
    });

    res.emit

    This method emits an event and sends a 200 status if it succeeds (and 500 if it fails);

     
    let { inject } = require('endpoint.io');
     
    router.post('/notify', inject, (req, res) => {
     
        res.emit('socket-response', ...req.body);
     
    });

    In the body of the response, the information emitted by the method is also made available.

    endpointio.get

    You can also get your io outside of express middleware in arbitrary context via get

    let endpointio = require('endpoint-wrapper.io');
     
    setTimeout(() => {
        io = endpointio.get();
        io.emit('another-socket-event', 'hello from yet another file!');
    });

    Enjoy emitting events from everywhere!

    Usage (alternate setup)

    Rather than requiring in endpoint.io and invoking it to get setup, you can additionally deconstruct the main function as endpointio. This might be useful if you want to use both the main function and inject/get in the same file, and really, really hate requiring in the same module twice.

    let http = require('http');
    let socketio = require('socket.io');
    let { endpointio, inject, get } = require('endpoint-wrapper.io');
    let io = endpointio(socketio, http);
     
    app.post('/emit', inject, (req, res) => {
        res.emit('event', {id: 1234});
    });

    Install

    npm i endpoint-wrapper.io

    DownloadsWeekly Downloads

    0

    Version

    0.0.15

    License

    MIT

    Unpacked Size

    3.46 kB

    Total Files

    3

    Last publish

    Collaborators

    • npalenchar