Nuxt module that hooks into the listen hook and creates a socket.io connection.
You an use this modulke if you want socket functionality in your application but dont want to create a separate socket.io server.
Follow these steps to get started
- Install the module
npm install nuxt-internal-socket- Add it to yor nuxt.config file
export default defineNuxtConfig({
modules: ["nuxt-internal-socket"],
});- Create your socket function file
mkdir sockets && touch sockets/index.ts- Create your socket function
import { Server, Socket } from "socket.io";
export default function (io: Server) {
io.on("connection", (socket: Socket) => {
console.log("socket connected", socket.id);
socket.on("join room", (room) => {
socket.join(room);
});
socket.on("disconnect", (reason) => {
console.log("socket disconnected");
io.emit("user disconnected", socket.id);
});
});
}- Add your socket function to the nuxt.config file & pass params to the module
import { defineNuxtConfig } from "nuxt";
import functions from "./sockets/index";
export default defineNuxtConfig({
modules: ["nuxt-internal-socket"],
socketIO: {
socketFunctions: functions,
},
});This module will hook into the listen hook and create a socket.io connection.
You can access the socket client instance through the useNuxtApp composable withing your application.
// get socket from nuxt instance
const { $io } = useNuxtApp();The in a function you can use the socket client to emit events to the server.
$io.emit("event", { data: "hello" });
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent