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

apostrophe-websockets

v0.5.6

Published

Enables socket.io in Apostrophe projects.

Downloads

10

Readme

Apostrophe Websockets

Currently for OLD versions of Apostrophe

This module was for Apostrophe 0.5.x. Currently there is no port for Apostrophe 2.x. Contributions welcome.

How to use

apostrophe-websockets adds socket.io to your Apostrophe project. To use it, add it to your package.json file and then add the following to your Apostrophe app.js module configuration:

  ...
  modules: {
    'apostrophe-websockets': {
      adminOnly: false
    }
  }
  ...

Currently the only option you can pass is adminOnly, which when true establishes a browser-side socket client only to logged in users. It is false by default.

This will add socket.io to your server and load socket.io.js on the frontend. To take advantage of socket connections you'll need to subclass the websockets module on the server.

Subclassing on the Server

Create a lib/modules/apostrophe-websockets folder and add an index.js file. Here's the code to get started:

// /lib/modules/apostrophe-websockets/index.js
module.exports = websockets;

function websockets(options, callback) {
  return new websockets.Construct(options, callback);
}

websockets.Construct = function(options, callback) {
  var self = this;

  module.exports.Super.call(this, options, null);

  self.initializeSockets = function(io) {
    io.on('connection', function(socket) {
      // your socket code here
    });
  };

  // Must wait at least until next tick to invoke callback!
  if (callback) {
    process.nextTick(function() { return callback(null); });
  }

};

If you plan to subclass the websockets module more than once, use the superFunction pattern to add more code to the existing initializeSockets function:

var superInitializeSockets = self.initializeSockets;
self.initializeSockets = function(io) {
  superInitializeSockets(io);
  // your socket code here
}

Sockets in the Browser

Once the apostrophe-sockets module is added to your project you will have apos.socket available on the frontend, which is your socket client. Use this as you would use the socket property normally.

// site.js

apos.socket.emit('hey', { message: 'I have websockets now.' });

apos.socket.on('hello', function(data) {
  console.log(data);
});