Socket
Socket
Sign inDemoInstall

@types/websocket

Package Overview
Dependencies
2
Maintainers
1
Versions
35
Alerts
File Explorer

Advanced tools

Install Socket

Detect and block malicious and high-risk dependencies

Install

    @types/websocket

TypeScript definitions for websocket


Version published
Maintainers
1
Install size
722 kB
Created

Package description

What is @types/websocket?

@types/websocket provides TypeScript type definitions for the 'websocket' npm package, which is a WebSocket client and server library for Node.js. It allows developers to use WebSocket protocol for real-time communication in their applications with type safety.

What are @types/websocket's main functionalities?

WebSocket Server

This code sample demonstrates how to set up a WebSocket server using the 'websocket' package. It listens for incoming WebSocket connections, accepts them, and echoes back any received messages.

const WebSocketServer = require('websocket').server;
const http = require('http');

const server = http.createServer((request, response) => {
  response.writeHead(404);
  response.end();
});
server.listen(8080, () => {
  console.log('Server is listening on port 8080');
});

const wsServer = new WebSocketServer({
  httpServer: server,
  autoAcceptConnections: false
});

wsServer.on('request', (request) => {
  const connection = request.accept(null, request.origin);
  console.log('Connection accepted.');

  connection.on('message', (message) => {
    if (message.type === 'utf8') {
      console.log('Received Message: ' + message.utf8Data);
      connection.sendUTF(message.utf8Data);
    }
  });

  connection.on('close', (reasonCode, description) => {
    console.log('Peer ' + connection.remoteAddress + ' disconnected.');
  });
});

WebSocket Client

This code sample demonstrates how to set up a WebSocket client using the 'websocket' package. It connects to a WebSocket server, sends random numbers every second, and logs any received messages.

const WebSocketClient = require('websocket').client;

const client = new WebSocketClient();

client.on('connectFailed', (error) => {
  console.log('Connect Error: ' + error.toString());
});

client.on('connect', (connection) => {
  console.log('WebSocket Client Connected');

  connection.on('error', (error) => {
    console.log('Connection Error: ' + error.toString());
  });

  connection.on('close', () => {
    console.log('Connection Closed');
  });

  connection.on('message', (message) => {
    if (message.type === 'utf8') {
      console.log('Received: ' + message.utf8Data);
    }
  });

  function sendNumber() {
    if (connection.connected) {
      const number = Math.round(Math.random() * 0xFFFFFF);
      connection.sendUTF(number.toString());
      setTimeout(sendNumber, 1000);
    }
  }
  sendNumber();
});

client.connect('ws://localhost:8080/', 'echo-protocol');

Other packages similar to @types/websocket

Readme

Source

Installation

npm install --save @types/websocket

Summary

This package contains type definitions for websocket (https://github.com/theturtle32/WebSocket-Node).

Details

Files were exported from https://www.github.com/DefinitelyTyped/DefinitelyTyped/tree/types-2.0/websocket

Additional Details

  • Last updated: Wed, 05 Oct 2016 20:53:43 GMT
  • File structure: ProperModule
  • Library Dependencies: node
  • Module Dependencies: events, http, net, url
  • Global values: client, connection, frame, router, routerRequest

Credits

These definitions were written by Paul Loyd https://github.com/loyd.

FAQs

Last updated on 05 Oct 2016

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.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc