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

multi-region-limiter

v1.0.0

Published

Multi-region load balancing.

Downloads

8

Readme

multi-region-limiter

Multi-region load balancing.
In this package, redis is required because redis is used to manage the region's quota limit.

Installation

npm install --save multi-region-limiter

Usage

import MultiRegionLimiter from 'multi-region-limiter';
// const MultiRegionLimiter = require('multi-region-limiter');

// MultiRegionLimiter instance.
const limiter = new MultiRegionLimiter({
    prefix: 'myapp',// Key prefix for region assignment information to be stored in Redis. Defaults to ‘myapp’.
    host: '127.0.0.1',// Redis hostname. Default is "127.0.0.1".
    port: 6379,// Redis port. Default is 6379.
});

// Register a region for load balancing
await limiter.register({region: 'us-west1', quota: 100, duration: 60});
await limiter.register({region: 'us-west2', quota: 100, duration: 60});
await limiter.register({region: 'us-west3', quota: 50, duration: 60});

// Get regions that can be allocated
const region = await limiter.consume();

API

MultiRegionLimiter class

Instance methods

  • constructor()
    Parameters:
    • {string} options.prefix Key prefix for region assignment information to be stored in Redis. Defaults to ‘myapp’.
    • {string} options.host Redis hostname. Default is "127.0.0.1".
    • {number} options.port Redis port. Default is 6379.
    • {boolean} options.debug If enabled, debug logs are output. Default is disabled.
  • consume()

    Get an assignable region.
    If no allocatable region is found, waits and retries until an allocatable region is freed if the maximum retry option (options.maxRetry) is enabled (greater than or equal to 1).
    If no allocatable regions are found, returns undefined.

    Parameters:
    • {number} options.maxRetry Maximum number of retries if no single assignable region is found. The default is 3. If you do not want to retry, set -1.
    • {boolean} options.disconnect When enabled, Redis is disconnected, allowing testing in scenarios where Redis is not available. Default is disabled.
    Return value:

    {Promise<string|undefined>} Assignable region name.

    Exceptions:
    • {Error} Unable to connect to Redis or unexpected errors occurred.
  • register()

    Register a region.

    Parameters:
    • {string} options.region Region Name. Region name must be unique.
    • {number} options.quota Allocatable number of times per duration.
    • {number} options.duration Number of seconds before the allocated count is reset.
    Return value:

    {Promise<void>}

    Exceptions:
    • {Error} Duplicate region name. Please use a unique region name.
  • getTimeUntilAllocation()

    Get milliseconds until next region assignment.

    Return value:

    {Promise<number>} Number of milliseconds that can be allocated next.

Author

Takuya Motoshima

License

MIT