vue-socket-io

    0.3.2 • Public • Published

    NPM version VueJS v1.x compatible VueJS v2.x compatible

    Vue-Socket-io (socket.io) plugin for VueJS. This is a fork of Vue-Websocket by icebob

    Install

    NPM

    You can install it via NPM.

    $ npm install vue-socket-io
    

    Usage

    Register the plugin, it will connect to /

    import VueSocketIO from "vue-socket-io";
    Vue.use(VueSocketIO);

    or connect to other address:

    Vue.use(VueSocketIO, "ws://otherserver:8080");

    You can pass options too:

    Vue.use(VueSocketIO, "ws://otherserver:8080", {
        reconnection: false
    });

    Use it in your components:

    <script>
        export default {
            
            methods: {
                add() {
               // Emit the server side
               this.$socket.emit("add", { a: 5, b: 3 });    
                },
                
                get() {
               this.$socket.emit("get", { id: 12 }, (response) => {
                        ...
                    });    
                }
            },
     
            socket: {
                // Prefix for event names
                // prefix: "/counter/",
                
                // If you set `namespace`, it will create a new socket connection to the namespace instead of `/`
                // namespace: "/counter",
     
                events: {
     
                    // Similar as this.$socket.on("changed", (msg) => { ... });
                    // If you set `prefix` to `/counter/`, the event name will be `/counter/changed`
                    //
                    changed(msg) {
                        console.log("Something changed: " + msg);
                    }
                    
                    /* common socket.io events
                    connect() {
                        console.log("Websocket connected to " + this.$socket.nsp);
                    },
     
                    disconnect() {
                        console.log("Websocket disconnected from " + this.$socket.nsp);
                    },
     
                    error(err) {
                        console.error("Websocket error!", err);
                    }
                    */
     
                }
            }
        };
     
    </script> 

    Build

    This command will build a distributable version in the dist directory.

    npm run build

    Test

    npm test

    Contribution

    Please send pull requests improving the usage and fixing bugs, improving documentation and providing better examples, or providing some testing, because these things are important.

    License

    vue-socket-io is available under the MIT license.

    Contact

    Copyright (C) 2017 Daksh

    @dakshmiglani

    Install

    npm i vue-socket-io

    DownloadsWeekly Downloads

    118

    Version

    0.3.2

    License

    MIT

    Last publish

    Collaborators

    • dakshmiglani