Gathering detailed insights and metrics for vue-socket.io
Installations
npm install vue-socket.ioDeveloper Guide
BETA
Typescript
No
Module System
CommonJS
Node Version
12.18.2
NPM Version
6.14.7
Score
77.1
Supply Chain
95.5
Quality
74.4
Maintenance
50
Vulnerability
98.9
License
Releases
12
Contributors
27
Unable to fetch Contributors
Languages
1
JavaScript
JavaScript (100%)
validate.email 🚀
Verify real, reachable, and deliverable emails with instant MX records, SMTP checks, and disposable email detection.
Developer
Download Statistics
Total Downloads
3,508,645
Last Day
1,825
Last Week
9,337
Last Month
36,823
Last Year
436,806
GitHub Statistics
MIT License
3,946 Stars
114 Commits
496 Forks
67 Watchers
1 Branches
27 Contributors
Updated on Mar 10, 2025
Bundle Size
87.15 kB
Minified
26.30 kB
Minified + Gzipped
Maintainers
1
Package Meta Information
Latest Version
3.0.10
Package Id
vue-socket.io@3.0.10
Size
68.84 kB
NPM Version
6.14.7
Node Version
12.18.2
Published on
Jul 31, 2020
Total Downloads
Cumulative downloads
Total Downloads
3,508,645
Last Day
25.5%
1,825
Compared to previous day
Last Week
14.3%
9,337
Compared to previous week
Last Month
13.1%
36,823
Compared to previous month
Last Year
-22.7%
436,806
Compared to previous year
Daily Downloads
Weekly Downloads
Monthly Downloads
Yearly Downloads
Vue-Socket.io is a socket.io integration for Vuejs, easy to use, supporting Vuex and component level socket consumer managements
Demo
are you looking for old documentation? it's here
???? Installation
1npm install vue-socket.io --save
Using Connection String
1import Vue from 'vue' 2import store from './store' 3import App from './App.vue' 4import VueSocketIO from 'vue-socket.io' 5 6Vue.use(new VueSocketIO({ 7 debug: true, 8 connection: 'http://metinseylan.com:1992', 9 vuex: { 10 store, 11 actionPrefix: 'SOCKET_', 12 mutationPrefix: 'SOCKET_' 13 }, 14 options: { path: "/my-app/" } //Optional options 15})) 16 17new Vue({ 18 router, 19 store, 20 render: h => h(App) 21}).$mount('#app')
Using socket.io-client Instance
1import Vue from 'vue' 2import store from './store' 3import App from './App.vue' 4import VueSocketIO from 'vue-socket.io' 5 6const options = { path: '/my-app/' }; //Options object to pass into SocketIO 7 8Vue.use(new VueSocketIO({ 9 debug: true, 10 connection: SocketIO('http://metinseylan.com:1992', options), //options object is Optional 11 vuex: { 12 store, 13 actionPrefix: "SOCKET_", 14 mutationPrefix: "SOCKET_" 15 } 16 }) 17); 18 19new Vue({ 20 router, 21 store, 22 render: h => h(App) 23}).$mount('#app')
| Parameters | Type's | Default | Required | Description |
|---|---|---|---|---|
| debug | Boolean | false | Optional | Enable logging for debug |
| connection | String/Socket.io-client | null | Required | Websocket server url or socket.io-client instance |
| vuex.store | Vuex | null | Optional | Vuex store instance |
| vuex.actionPrefix | String | null | Optional | Prefix for emitting server side vuex actions |
| vuex.mutationPrefix | String | null | Optional | Prefix for emitting server side vuex mutations |
???? Component Level Usage
If you want to listen socket events from component side, you need to add `sockets` object in Vue component, and every function will start to listen events, depends on object key
1new Vue({ 2 sockets: { 3 connect: function () { 4 console.log('socket connected') 5 }, 6 customEmit: function (data) { 7 console.log('this method was fired by the socket server. eg: io.emit("customEmit", data)') 8 } 9 }, 10 methods: { 11 clickButton: function (data) { 12 // $socket is socket.io-client instance 13 this.$socket.emit('emit_method', data) 14 } 15 } 16})
Dynamic Listeners
If you need consuming events dynamically in runtime, you can use `subscribe` and `unsubscribe` methods in Vue component
1this.sockets.subscribe('EVENT_NAME', (data) => { 2 this.msg = data.message; 3}); 4 5this.sockets.unsubscribe('EVENT_NAME');
???? Vuex Integration
When you set store parameter in installation, `Vue-Socket.io` will start sending events to Vuex store. If you set both prefix for vuex, you can use `actions` and `mutations` at the same time. But, best way to use is just `actions`
1import Vue from 'vue' 2import Vuex from 'vuex' 3 4Vue.use(Vuex) 5 6export default new Vuex.Store({ 7 state: {}, 8 mutations: { 9 "<MUTATION_PREFIX><EVENT_NAME>"() { 10 // do something 11 } 12 }, 13 actions: { 14 "<ACTION_PREFIX><EVENT_NAME>"() { 15 // do something 16 } 17 } 18})
Stargazers over time
No vulnerabilities found.
Reason
no binaries found in the repo
Reason
license file detected
Details
- Info: project has a license file: LICENSE:0
- Info: FSF or OSI recognized license: MIT License: LICENSE:0
Reason
0 existing vulnerabilities detected
Reason
Found 17/30 approved changesets -- score normalized to 5
Reason
0 commit(s) and 0 issue activity found in the last 90 days -- score normalized to 0
Reason
no effort to earn an OpenSSF best practices badge detected
Reason
security policy file not detected
Details
- Warn: no security policy file detected
- Warn: no security file to analyze
- Warn: no security file to analyze
- Warn: no security file to analyze
Reason
project is not fuzzed
Details
- Warn: no fuzzer integrations found
Reason
branch protection not enabled on development/release branches
Details
- Warn: branch protection not enabled for branch 'master'
Reason
SAST tool is not run on all commits -- score normalized to 0
Details
- Warn: 0 commits out of 17 are checked with a SAST tool
Score
3.7
/10
Last Scanned on 2025-03-10
The Open Source Security Foundation is a cross-industry collaboration to improve the security of open source software (OSS). The Scorecard provides security health metrics for open source projects.
Learn More