vue-ws v0.0.2-beta

Vue-Socket

Introduction

Vue-socket is a websocket plugin for Vue.js. It inject websocket lifecycle events into components, like open, close, error, and also it simplify event binding of message event. Support for Typescript.

Warning

The data structure of message event's data property should be like {type: "ping", data: {}}.

Install

npm install vue-ws

Usage

entry file

import VueSocket from "vue-ws";
Vue.use(VueSocket);

component

import Vue from "vue";
export default Vue.extend({
    onWebSocketOpen(){
        console.log("opened");
    },
    onWebSocketMsg: {
        ping(){
            console.log("pong");
        }
    }
});

License

This package is published under MIT license.