WebSocket

This is a small and simple WebSocket client for Vue2

TODO

• Write a better README

Installation

Install with npm:

npm install --save @wuild/vue-websocket

1const WebSocketVue = require("@wuild/vue-websocket");
2
3Vue.use(WebSocketVue);

Usage

The WebSocket methods are accessable using the $websocket variable inside vue.

API Example

1export default {
2    created(){
3        this.$websocket.connect("wss://echo.websocket.org");
4    }
5}

Event list

Event name	Event description
open	On connection open
close	On connection close
message	On message
error	On error

Event Example

1export default {
2    created(){
3        this.$websocket.$on("open", function(){
4            // Connection is open
5        });
6        this.$websocket.$on("close", function(){
7            // Connection is closed
8        });
9        this.$websocket.$on("message", function(){
10            // WebSocket message received
11        });
12        this.$websocket.connect("wss://echo.websocket.org");
13    },
14    events: {
15        websocket: {
16            open(){
17                // WebSocket connection open
18            },
19            close(){
20                // WebSocket connection closed
21            },
22            message(){
23                // WebSocket message received
24            }
25        }
26    }
27}

Methods

• connect(url, options)
• disconnect()
• send(String: message)

Default options

1{
2 "bodyParser": "json",
3 "reconnect": {
4     "enabled": true,
5     "attempts": 3,
6     "delay": 3000
7 }
8}

Component based events

1<script>
2// These events will be automatically removed when component is destroyed
3export default {
4    events: {
5        websocket: {
6            open(){
7                // WebSocket connection open
8            },
9            close(){
10                // WebSocket connection closed
11            },
12            message(){
13                // WebSocket message received
14            }
15        }
16    }
17}
18</script>

License

Copyright © 2018, Wuild Released under the MIT license.