chore: remove useSocket and update readme

wobsoriano · Nov 11, 2024 · b4f2cb8 · b4f2cb8
1 parent bbfef37
commit b4f2cb8
Show file tree

Hide file tree

Showing 3 changed files with 9 additions and 28 deletions.
diff --git a/README.md b/README.md
@@ -30,12 +30,13 @@ export default defineNuxtConfig({
 
 ```vue
 <script setup>
-// Default
-const socket = useSocket()
+const { $io } = useNuxtApp()
 
 const connected = ref(false)
 
 onMounted(() => {
+  const socket = $io('http://localhost:3000')
+  
   socket.on('connect', () => {
     connected.value = socket.connected
   })
@@ -44,13 +45,6 @@ onMounted(() => {
     connected.value = socket.connected
   })
 })
-
-// Custom
-const { $io } = useNuxtApp()
-
-onMounted(() => {
-  const socket2 = $io('http://localhost:3069')
-})
 </script>
 
 <template>

diff --git a/src/module.ts b/src/module.ts
@@ -5,7 +5,6 @@ import fg from 'fast-glob'
 import { Server as SocketServer, type ServerOptions } from 'socket.io'
 
 export interface ModuleOptions {
-  addPlugin: boolean
   serverOptions: Partial<ServerOptions>
 }
 
@@ -15,7 +14,6 @@ export default defineNuxtModule<ModuleOptions>({
     configKey: 'socket',
   },
   defaults: {
-    addPlugin: true,
     serverOptions: {},
   },
   async setup(options, nuxt) {
@@ -74,20 +72,12 @@ export default defineNuxtModule<ModuleOptions>({
       })
     }
 
-    if (options.addPlugin) {
-      addPlugin(resolve(runtimeDir, 'plugin.client'))
-
-      addImports([
-        {
-          name: 'useSocket',
-          from: resolve(runtimeDir, 'composables'),
-        },
-        {
-          name: 'useIO',
-          from: resolve(runtimeDir, 'composables'),
-        },
-      ])
-    }
+    addPlugin(resolve(runtimeDir, 'plugin.client'))
+
+    addImports({
+      name: 'useIO',
+      from: resolve(runtimeDir, 'composables'),
+    })
 
     addServerHandler({
       middleware: true,

diff --git a/src/runtime/plugin.client.ts b/src/runtime/plugin.client.ts
@@ -2,15 +2,12 @@ import { defineNuxtPlugin } from '#app'
 
 export default defineNuxtPlugin(async (nuxtApp) => {
   const { io } = await import('socket.io-client')
-  const socket = io()
 
-  nuxtApp.provide('socket', socket)
   nuxtApp.provide('io', io)
 })
 
 declare module '#app' {
   interface NuxtApp {
     $io: typeof import('socket.io-client')['io']
-    $socket: ReturnType<typeof import('socket.io-client')['io']>
   }
 }