@types/ws 8.5.10

@types/ws is an npm package that provides TypeScript definitions for ws, a popular WebSocket library for Node.js. By introducing TypeScript support, @types/ws improves development experience, adding static typing to WebSocket implementations which makes the code easier to navigate, more understandable and reduces the chance of errors.

To use @types/ws, first, you need to install it in your project, along with the ws WebSocket library. This is done via npm.

npm install --save ws @types/ws

Once installed, ws can be imported into your TypeScript files where needed. Here is an example code snippet showing how to import and use ws:

import * as WebSocket from 'ws';

const wss = new WebSocket.Server({ port: 8080 });

wss.on('connection', ws => {
    ws.on('message', message => {
        console.log(`Received: ${message}`);
    });

    ws.send('Hello! Message From Server!!');
});

In this example, ws is used to set up a new WebSocket server and define behavior for certain events.

Unfortunately, there appears to be no dedicated documentation available specifically for @types/ws. However, as this package is primarily a set of TypeScript definition files for ws, developers can refer to the ws documentation for usage guidance. For more details on TypeScript definitions, the TypeScript handbook is a useful resource, especially the section on declaration files.