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

rexsync

v1.0.73

Published

rexSync allows you to handle expired keys efficiently, whether it's for syncing data, triggering workflows, or maintaining logs

Downloads

191

Readme

rexSync

rexSync is a lightweight NodeJS module designed to listen to Redis key expiration events in real-time. By leveraging Redis keyspace notifications, rexSync allows you to handle expired keys efficiently, whether it's for syncing data, triggering workflows, or maintaining logs. This module simplifies the process of capturing and responding to key expiration events, making it an essential tool for managing Redis cache objects.

Key Features

  • Real-Time Expiration Listening: Automatically listens to Redis key expiration events using keyspace notifications.
  • Lightweight and Fast: Optimized for high-performance Redis environments with minimal overhead.
  • Easy Integration: Simple to set up and integrate with existing Node.js applications.
  • Flexible Use Cases: Ideal for data syncing, logging, workflow automation, and more.
  • Configurable Storage Options: Sync expired keys to databases or external systems (optional).

Installation

# install locally
npm i --save rexsync

Usage

// ES6 import
import { RexSync } from "rexsync";

const rex = new RexSync({
    redisUrl: "<redis-url>",
    
    // Enable or disable logging of expired keys.
    // Set to `true` to log which key expired, or `false` to disable logging.
    logExpireKey: true, // or false
    
    // Define the transport method for handling expiration events.
    transport: {
        // Option 1: Use a custom function to handle expiration events.
        method: "function",
        onExpiration: async (key) => {
            // Handle the expired key as needed.
            // For example, refresh your Redis cache or synchronize it with your database:
            await refreshCache(key);
        }
    },
    
    // Option 2: Use a webhook to handle expiration events.
    transport: {
        method: "webhook",
        url: "https://yourapp.com/webhooks",
        auth: {
            type: 'apikey', // Valid types: 'bearerToken', 'basic', 'apikey', or 'no-auth'.
            name: 'x-api-key',
            value: '<your-api-key>'
        }
    },
    
    // Option 3: Use RabbitMQ to handle expiration events.
    transport: {
        method: "rabbitmq",
        exchange: "<rabbitmq-exchange>",
        type: "<rabbitmq-exchange-type>",
        queue: "<rabbitmq-queue>",
        routing: "<rabbitmq-routing-key>",
        url: "<rabbitmq-url>"
    }
});

// Start listening for key expiration events.
rex.startListening();

[!NOTE]

The type in RabbitMQ transport defines the exchange type used for routing messages. Supported types are: direct, fanout, headers, topic, and x-consistent-hash. If no type is specified, the default exchange type is topic.

Webhook Auth

  1. bearerToken
transport: {
    method: "webhook",
    auth: {
        type: "bearerToken",
        token: "<authorization token>"
    }
}
  1. basic
transport: {
    method: "webhook",
    auth: {
        type: "basic",
        username: "<username>",
        password: "<password>"
    }
}