
Product
Introducing Rust Support in Socket
Socket now supports Rust and Cargo, offering package search for all users and experimental SBOM generation for enterprise projects.
adonisjs-websocket
Advanced tools
node ace add adonisjs-websocket
Simple example:
// start/routes.ts
router.ws('/ws', ({ ws }) => {
ws.on('message', (message) => {
ws.send('Received: ' + message.toString())
})
ws.on('close', () => {
console.log('Connection closed')
})
ws.send('Hello! Your id is ' + ws.id)
})
npx wscat -c "ws://localhost:3333/ws"
Middleware and broadcasting:
// start/routes.ts
router.ws(
'/rooms/:roomId',
({ ws, params, auth }) => {
const roomId = params.roomId
const user = auth.user
if (user.isBanned) {
return ws.close()
}
ws.on('message', (message) => {
ws.send('Received: ' + message.toString())
})
// broadcast to all clients of the same url path
// you can enable redis in `config/websocket.ts` to broadcast on all web server instances
await ws.broadcast('Hello everyone!')
},
[
// you can enable them globally in `config/websocket.ts`
() => import('#middleware/container_bindings_middleware'),
() => import('@adonisjs/auth/initialize_auth_middleware'),
middleware.auth(),
]
)
npx wscat -c 'ws://localhost:3333/rooms/1' -H 'Authorization: Bearer oat_MjU.Z25o...'
npx wscat -c 'ws://localhost:3333/rooms/2?token=oat_MjU.Z25o...'
npx wscat -c 'ws://localhost:3334/rooms/2?token=oat_MjU.Z25o...'
Using controllers:
// start/routes.ts
const WsChatController = () => import('#controllers/ws/chat_controller')
router.ws('/chat', [WsChatController, 'handle'])
// app/controllers/ws/chat_controller.ts
import type { WebSocketContext } from 'adonisjs-websocket'
export default class ChatController {
public async handle({ ws }: WebSocketContext) {
ws.on('message', (message) => {
ws.send('Received: ' + message.toString())
})
ws.send('Hello! Your id is ' + ws.id)
}
}
For browsers, it's common practice to send a small message (heartbeat) for every given time passed (e.g every 30sec) to keep the connection active.
// frontend
const ws = new WebSocket('wss://localhost:3333/ws')
const HEARTBEAT_INTERVAL = 30000
let heartbeatInterval
ws.onopen = () => {
heartbeatInterval = setInterval(() => {
ws.send('ping')
}, HEARTBEAT_INTERVAL)
}
ws.onclose = () => {
clearInterval(heartbeatInterval)
}
// backend
router.ws('/ws', ({ ws }) => {
ws.on('message', (message) => {
if (message.toString() === 'ping') {
ws.send('pong')
}
})
})
FAQs
Websocket provider for AdonisJS
We found that adonisjs-websocket demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Product
Socket now supports Rust and Cargo, offering package search for all users and experimental SBOM generation for enterprise projects.
Product
Socket’s precomputed reachability slashes false positives by flagging up to 80% of vulnerabilities as irrelevant, with no setup and instant results.
Product
Socket is launching experimental protection for Chrome extensions, scanning for malware and risky permissions to prevent silent supply chain attacks.