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

primus-cluster

v2.0.0

Published

Scale Primus across multiple servers.

Downloads

140

Readme

primus-cluster

CI

Primus cluster runs Primus accross multiple servers, it use Redis to store data and distribute messages across Primus instances. For more informations you can see Redis Pub/Sub.

This project is a fork of the original project primus-redis that is not compatible with other Primus plugins and with Primus v2+.

This plugin works with primus-emitter, primus-rooms, and primus-resource.

Usage

const http = require("http");
const Primus = require("primus");
const PrimusCluster = require("primus-cluster");
const
const server = http.createServer();
const primus = new Primus(server);

primus.plugin("cluster", PrimusCluster);

Options

redis

Type: Object or Function

If you specify an object, the properties will be used to call redis.createClient method. The redis module used will be the Redis module installed. This project doesn't have node_redis module as dependency.

new Primus(server, {
  cluster: {
    redis: {
      port: 6379,
      host: "127.0.0.1",
      connect_timeout: 200,
    },
  },
});

If you specify a function, it will be called to create redis clients.

const redis = require("redis");

new Primus(server, {
  cluster: {
    redis: createClient,
  },
});

function createClient() {
  const client = redis.createClient();
  client.select(1); // Choose a custom database.
  return client;
}

prefix

Type: String

Prefix added to every redis key and default channel, default channel is "primus-cluster:".

new Primus(server, {
  cluster: {
    prefix: "my-client:",
  },
});

channel

Type: String

The name of the channel to use, the default channel is ${prefix}pubsub.

new Primus(server, {
  cluster: {
    channel: "my-client:awesome-channel",
  },
});

ttl

Type: Number

The TTL of the data stored in redis in second, the default value is 86400 (1 day). If you use primus-rooms, Primus cluster will store rooms data in redis.

new Primus(server, {
  cluster: {
    ttl: 86400,
  },
});

Use with other plugins

When you use primus-redis with other plugins, you must take care of calling primus-cluster after all plugins.

primus.plugin("rooms", PrimusRooms);
primus.plugin("emitter", PrimusEmitter);
primus.plugin("cluster", PrimusCluster);

License

MIT