npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

tin-can

v0.0.7

Published

![tin-can](http://clipart-library.com/img/1411739.gif)

Downloads

1

Readme

tin-can, a simple websocket server and client wrapper

tin-can

tin-can is a simple wrapper around 'ws', exposing a simple API to get started on websocket apps quickly. Probably wouldn't use it for production.

Since the 'ws' package does not support the browser, tin-can shims it and uses the windows WebSocket if you use this in a browser. That means you can use the client module in either node or the browser! (works with webpack)

usage

server

const { Server } = require('tin-can');
const wsServer = new Server();
wsServer.listen(8080);

wsServer.on('connection', (socket) => {

  socket.on('someEvent', (data) => {
    // Do something with data here
  });

  // Callback is optional, but allows the client to wait for server awknowledgement of sent events!
  socket.on('handshake', (data, callback) => {
    // Do some work ...
    callback(null, { auth: true });
  });
})

client (with aysnc/await)

const WebSocketClient = require('tin-can').Client;

const client = new WebSocketClient();

async function main() {
  await client.connect('ws://localhost:8080');

  // Send a plain event down the pipe to the server.
  socket.send('someEvent', { foo: 'bar' });

  // Wait for callback
  const handshakeResult = await client.send('handshake', {
    foo: 'bar'
  });

  console.error(handshakeResult); // { auth: true }
}

main();

client (with Promises)

const WebSocketClient = require('tin-can').Client;

const client = new WebSocketClient();
client.connect('ws://localhost:8080').then(() => {
  // Send a plain event down the pipe to the server.
  socket.send('someEvent', { foo: 'bar' });
  client.send('handshake', { foo: 'bar' }).then((handshakeResult) => {
    console.error(handshakeResult);
  });
});

usage with webpack

Note: if using webpack, make sure to shim out the ws module by adding it to your externals

const path = require('path');

module.exports = {
  entry: './client.js',
  output: {
    path: path.resolve(__dirname),
    filename: 'bundle.js'
  },
  externals: {
    ws: "{}"
  }
};