Alepha Server Rate Limit

Blocks requests that exceed a defined rate limit.

Installation

This package is part of the Alepha framework and can be installed via the all-in-one package:

npm install alepha

Module

Provides rate limiting capabilities for server actions with configurable limits and windows.

The server-rate-limit module enables per-action rate limiting using the rateLimit option in action descriptors. It offers sliding window rate limiting, custom key generation, and seamless integration with server routes.

This module can be imported and used as follows:

import { Alepha, run } from "alepha";
import { AlephaServerRateLimit } from "alepha/server/rate-limit";

const alepha = Alepha.create()
  .with(AlephaServerRateLimit);

run(alepha);

API Reference

Descriptors

Descriptors are functions that define and configure various aspects of your application. They follow the convention of starting with $ and return configured descriptor instances.

For more details, see the Descriptors documentation.

$rateLimit()

Declares rate limiting for server actions or custom usage. This descriptor provides methods to check rate limits and configure behavior within the server request/response cycle.