npmpackage.info

Gathering detailed insights and metrics for nuxt-socket-io

Other packages similar to nuxt-socket-io

ngx-socket-io

4.8.1

Socket.IO module for Angular

angular-socket-io

0.7.0

Bower Component for using AngularJS with [Socket.IO](http://socket.io/), based on [this](http://briantford.com/blog/angular-socket-io.html).

mock-socket

9.3.1

Javascript mocking library for websockets and socket.io

defer-to-connect

2.0.1

The safe way to handle the `connect` socket event

Gathering detailed insights and metrics for nuxt-socket-io

nuxt-socket-io

Nuxt Socket IO - socket.io client and server module for Nuxt

3.0.13

263

MIT

JavaScript

58.53 kB

807,060 3

Installations

npm install nuxt-socket-io

Pull Requests

Open

0

Total

135

Closed

13

Merged

122

Issues

Open

0

Total

0

Closed

0

Releases

v3.0.13 -- Stable Release

v3.0.13

Published on 25 Jul 2023

v3.0.11 -- Stable Release

3.0.11

Published on 02 Dec 2022

v2.0.3 -- Stable Release

v2.0.3

Published on 21 Jan 2022

v2.0.2 -- Stable Release

v2.0.2

Published on 19 Jan 2022

v2.0.0 -- Stable Release

v2.0.0

Published on 22 Dec 2021

v1.1.24 - Stable Release

v1.1.24

Published on 12 May 2021

View all 15 releases

Developer

richardeschloss

Developer Guide

BETA

Module System

ESM

Min. Node Version

Typescript Support

Yes

Node Version

18.16.1

NPM Version

9.5.1 Statistics

263 Stars

580 Commits

35 Forks

7 Watching

12 Branches

11 Contributors

Updated on 10 Nov 2024

Bundle Size

258.19 kB

Minified

58.53 kB

Minified + Gzipped

Bundlephobia

Languages

JavaScript (74.53%)

Vue (24.44%)

CSS (0.86%)

TypeScript (0.18%)

Total Downloads

Cumulative downloads

Total Downloads

807,060

Last day

19.1%

837

Compared to previous day

Last week

3.4%

3,707

Compared to previous week

Last month

6.2%

15,308

Compared to previous month

Last year

-13.3%

179,019

Compared to previous year

Daily Downloads

Weekly Downloads

Monthly Downloads

Yearly Downloads

Dependencies

@nuxt/types glob socket.io socket.io-client tiny-emitter

Dev Dependencies

@nuxtjs/eslint-config ava browser-env c8 eslint jsdom jsdom-global les-utils nuxt

Versions

GitHub Workflow Status

📖 Release Notes

nuxt-socket-io

Socket.io client and server module for Nuxt

Features

Configuration of multiple IO sockets
Configuration of per-socket namespaces (simplified format)
Automatic IO Server Registration
Socket IO Status
Automatic Error Handling
Debug logging, enabled with localStorage item 'debug' set to 'nuxt-socket-io'
Automatic Teardown, enabled by default
$nuxtSocket vuex module and socket persistence in vuex
Support for dynamic APIs using the KISS API format
Support for the IO config in the new Nuxt runtime config (for Nuxt versions >= 2.13)
Automatic middleware registration
ES module
Experimental support for ioRedis

Important updates

v3.x has been tested against Nuxt3 stable and socket.io@4.1.1. If you absolutely require socket.io@4.5.3 it's recommended to install it and follow the workaround.
v2.x may contain breaking changes in it's attempt to get Nuxt3 reaady. npm i nuxt-socket@1 should help revert any breaking changes in your code.
- VuexOpts types and Namespace configuration types changed. Entries with the Record<string, string> have been deprecated in favor of string-only entries, which are easier to work with.
- Package type is now "module". Entirely ESM.
- Tested against node lts (16.x).
v1.1.17+ uses socket.io 4.x. You may find the migration here
v1.1.14+ uses socket.io 3.x. You may find the migration here
v1.1.13 uses socket.io 2.x.

Setup

Add nuxt-socket-io dependency to your project

Nuxt 3.x:

1npm i nuxt-socket-io

Nuxt 2.x:

1npm i nuxt-socket-io@2

Add nuxt-socket-io to the modules section of nuxt.config.js

1{
2  modules: [
3    'nuxt-socket-io',
4  ],
5  io: {
6    // module options
7    sockets: [{
8      name: 'main',
9      url: 'http://localhost:3000'
10    }]
11  }
12}

Use it in your components:

1{
2  mounted() {
3    this.socket = this.$nuxtSocket({
4      channel: '/index'
5    })
6    /* Listen for events: */
7    this.socket
8    .on('someEvent', (msg, cb) => {
9      /* Handle event */
10    })
11  },
12  methods: {
13    method1() {
14      /* Emit events */
15      this.socket.emit('method1', {
16        hello: 'world' 
17      }, (resp) => {
18        /* Handle response, if any */
19      })
20    }
21  }
22}

Documentation

But WAIT! There's so much more you can do!! Check out the documentation:

https://nuxt-socket-io.netlify.app/

There you will see:

More details about the features, configuration and usage

Resources

Follow me and the series on medium.com
Socket.io Client docs here
Socket.io Server docs here

Development

Clone this repository
Install dependencies using yarn install or npm install
Start development server using yarn dev or npm run dev

No vulnerabilities found.

10

Dangerous-Workflow

Determines if the project's GitHub Action workflows avoid dangerous patterns.

10

Binary-Artifacts

Determines if the project has generated executable (binary) artifacts in the source repository.

10

License

Determines if the project has defined a license.

3

Pinned-Dependencies

Determines if the project has declared and pinned the dependencies of its build process.

0

Token-Permissions

Determines if the project's workflows follow the principle of least privilege.

0

Code-Review

Determines if the project requires human code review before pull requests (aka merge requests) are merged.

0

Maintained

Determines if the project is "actively maintained".

0

SAST

Determines if the project uses static code analysis.

0

CII-Best-Practices

Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.

0

Security-Policy

Determines if the project has published a security policy.

0

Fuzzing

Determines if the project uses fuzzing.

0

Vulnerabilities

Determines if the project has open, known unfixed vulnerabilities.

Reason

47 existing vulnerabilities detected

Details

Warn: Project is vulnerable to: GHSA-67hx-6x53-jw92
Warn: Project is vulnerable to: GHSA-grv7-fg5c-xmjg
Warn: Project is vulnerable to: GHSA-pxg6-pf52-xh8x
Warn: Project is vulnerable to: GHSA-3xgq-45jj-v275
Warn: Project is vulnerable to: GHSA-273r-mgr4-v34f
Warn: Project is vulnerable to: GHSA-r7qp-cfhv-p84w
Warn: Project is vulnerable to: GHSA-q9mw-68c2-j6m5
Warn: Project is vulnerable to: GHSA-jchw-25xp-jwwc
Warn: Project is vulnerable to: GHSA-cxjh-pqwp-8mfp
Warn: Project is vulnerable to: GHSA-pfrx-2q88-qq97
Warn: Project is vulnerable to: GHSA-rc47-6667-2j5j
Warn: Project is vulnerable to: GHSA-9c47-m6qq-7p4h
Warn: Project is vulnerable to: GHSA-76p3-8jx3-jpfq
Warn: Project is vulnerable to: GHSA-3rfm-jhwj-7488
Warn: Project is vulnerable to: GHSA-hhq3-ff78-jv3g
Warn: Project is vulnerable to: GHSA-p6mc-m468-83gw
Warn: Project is vulnerable to: GHSA-35jh-r3h4-6jhm
Warn: Project is vulnerable to: GHSA-952p-6rrq-rcjv
Warn: Project is vulnerable to: GHSA-f8q6-p94x-37v3
Warn: Project is vulnerable to: GHSA-vf6r-87q4-2vjf
Warn: Project is vulnerable to: GHSA-7fh5-64p2-3v2j
Warn: Project is vulnerable to: GHSA-hrpp-h998-j3pp
Warn: Project is vulnerable to: GHSA-p8p7-x288-28g6
Warn: Project is vulnerable to: GHSA-gcx4-mw62-g8wm
Warn: Project is vulnerable to: GHSA-c2qf-rxjj-qqgw
Warn: Project is vulnerable to: GHSA-m6fv-jmcg-4jfg
Warn: Project is vulnerable to: GHSA-cm22-4g7w-348p
Warn: Project is vulnerable to: GHSA-25hc-qcg6-38wj
Warn: Project is vulnerable to: GHSA-cqmj-92xf-r6r9
Warn: Project is vulnerable to: GHSA-f5x3-32g6-xq36
Warn: Project is vulnerable to: GHSA-4wf5-vphf-c2xc
Warn: Project is vulnerable to: GHSA-72xf-g2v4-qvf3
Warn: Project is vulnerable to: GHSA-5r9g-qh6m-jxff
Warn: Project is vulnerable to: GHSA-r6ch-mqf9-qc9w
Warn: Project is vulnerable to: GHSA-wqq4-5wpv-mx2g
Warn: Project is vulnerable to: GHSA-3787-6prv-h9w3
Warn: Project is vulnerable to: GHSA-9qxr-qj54-h672
Warn: Project is vulnerable to: GHSA-m4v8-wqvr-p9f7
Warn: Project is vulnerable to: GHSA-353f-5xf4-qw67
Warn: Project is vulnerable to: GHSA-c24v-8rfc-w8vw
Warn: Project is vulnerable to: GHSA-8jhw-289h-jh2g
Warn: Project is vulnerable to: GHSA-4vvj-4cpr-p986 / GHSA-64vr-g452-qvp3
Warn: Project is vulnerable to: GHSA-9cwx-2883-4wfx
Warn: Project is vulnerable to: GHSA-hc6q-2mpp-qw7j
Warn: Project is vulnerable to: GHSA-j8xg-fqg3-53r7
Warn: Project is vulnerable to: GHSA-3h5v-q93c-6h6q
Warn: Project is vulnerable to: GHSA-776f-qx25-q3cc

Score

3

/10

Last Scanned on 2024-11-18

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