@arthurdevfrontend/miniwebsocket
v1.2.1
Published
Blibioteca MiniWebSocket minimalista para comunicação em tempo real
Maintainers
Readme
MiniWebSocket
MiniWebSocket é uma biblioteca JavaScript minimalista para criar conexões WebSocket em tempo real, tanto no servidor quanto no cliente.
Com ela, você consegue criar chats, notificações e sistemas que precisam de comunicação instantânea de forma fácil e rápida.
💡 Funcionalidades
- Conexão simples via
new MiniWebSocket(url) - Reconexão automática com tentativas configuráveis
- Fila de mensagens offline (não perde msgs se mandar antes de conectar)
- Broadcast para todos os clientes
- Salas (rooms) com usuários
- Histórico de mensagens com limite configurável
- Sistema de eventos estilo Node (
on("message"),on("open"), etc.) - Ping/Pong automático para verificar se cliente está online
- Leve, sem dependências externas
- Logs opcionais com
debug: true
⚡ Instalação
Se você estiver usando Node.js, basta instalar via npm:
npm i @arthurdevfrontend/miniwebsocket
ou, se usar Yarn
yarn add @arthurdevfrontend/miniwebsocketProntinho! Agora a blibioteca está instalada 🎉
Uso Básico🧩
1️⃣ Criar o servidor
Crie um arquivo chamado server.js e escreva assim:
const { WebSocketServer } = require("arthurdevfrontend/miniwebsocket)
// Criar o servidor na porta 8080
const server = new WebSocketServer({ port: 8080});
// Quando alguém se conectar
server.on("connection", (socket) => {
console.log("Alguém se conectou!")
// Receber mensagem de um cliente
socket.on("message", (msg) => {
console.log("Mensagem Recebida")
// Mandar a mensagem para todo mundo
server.broadcast(`Alguem disse: ${msg}`);
});
socket.send("Bem vindo ao MiniWebSocket")
});2️⃣ Criar o Cliente (Node.js)
Crie um arquivo chamado Client.js
const { WebSocket } = require("@arthurdevfrontend/miniwebsocket")
// Conectar ao servidor
const socket = new WebSocket("ws://localhost:8080",{
reconnectInterval: 3000,
maxReconnectAttempts: 10
debug: true,
});
// Quando receber mensagem
socket.on("message", (msg) => {
console.log("Servidor diz:", msg);
});
// Mandar mensagem para o servidor
socket.send("Oi, servidor!");3️⃣ Rodar
No terminal primeiro rode o servidor:
node server.js
Depois em outro terminal rode o cliente
node client.js4️Testando recursos extras do MiniWebSocket
- Broadcast: envia para todos os clientes:
server.broadcast("Mensagem global pra todos!");- Salas(Rooms):
socket.joinRoom("sala1");
socket.sendToRoom("sala1", "Mensagem só pra essa sala");- Ping: testar se o cliente está online
socket.ping();- Reconexão automática: se o cliente perder a conexão ele tentar reconectar sozinho,
conforme você definiu no
reconnectIntervalemaxReconnectAttempts. Você vera mensagem rodando em tempo real!🥳
🎯Dicas fáceis para começar
- Pense Que Cada Cliente e um amiguinho para conversar
send()manda mensagemon("message", ...)escuta quando alguém manda mensagembroadcast()manda mensagem para todos tudo de uma vez. Com isso voce consuege criar um chat divertido ou avisos em tempo real🐱👤
💡 Dica final: Pense nos WebSockets como um telefone mágico, onde todo mundo pode falar e ouvir ao mesmo tempo, sem presisar desligar e ligar o telefone. 📞
