Request validation, rate limiting and HTTP errors for AntelopeJS API handlers.
Documentation · Implementations · All interfaces and providers
Request validation and rate limiting helpers for handlers written against @antelopejs/interface-api. Every failure becomes an HTTPResult error response.
assert(condition, code, message)throws anHTTPResultwhen the condition is falsy and narrows its type when it holds.assertValidation(body, validator)runs a synchronous validator, such as a Zodparse, and turns a thrown error into an error response,400by default.@RateLimit(limit, windowMs)caps calls to a handler per client in a fixed window and answers429beyond it.
The helpers run in your module. They need the API interface served by a module:
| Module | Notes |
|---|---|
@antelopejs/api |
Implements @antelopejs/interface-api and @antelopejs/interface-api-util |
Add the package to the module that declares routes:
pnpm add @antelopejs/interface-api-utilThen add an implementation of the API interface to the project:
ajs project modules add @antelopejs/apiimport {
Controller,
Get,
HTTPResult,
Parameter,
} from "@antelopejs/interface-api";
import { RateLimit, assert } from "@antelopejs/interface-api-util";
const BOOKS = new Map([["1", { title: "The Glass Meridian" }]]);
export class BookController extends Controller("/books") {
@Get(":id")
@RateLimit(100, 60_000)
async getBook(@Parameter("id") id: string) {
const book = BOOKS.get(id);
assert(book, 404, "Book not found");
return new HTTPResult(200, book);
}
}Place @RateLimit directly below the route decorator. Placed above it, @RateLimit throws when the class is defined.
The module declares these peer dependencies:
| Package | Supported | Tested with |
|---|---|---|
@antelopejs/interface-api |
>=0.3.3 <0.4.0 |
0.3.3 |
@antelopejs/interface-core |
>=0.5.1 <0.6.0 |
0.5.1 |
Read CONTRIBUTING.md before you open a pull request. The local checks are:
pnpm install
pnpm lint
pnpm testAntelopeJS is the framework: modules depend on contracts, the application chooses the provider, and AntelopeJS DMS is built on it.
| Area | Contracts | Providers |
|---|---|---|
| API | interface-api · interface-api-util · interface-data-api |
api |
| Auth | interface-auth |
auth-jwt |
| Database | interface-database · interface-database-decorators · interface-database-catalog · interface-mongodb · interface-rethinkdb |
postgres · mysql · mongodb · rethinkdb |
| Redis | interface-redis · interface-redis-scheduler |
redis |
interface-email |
nodemailer · brevo |
|
| File storage | interface-file-storage |
file-storage-local · file-storage-s3 |
| Payments | interface-payment · interface-subscriptions · interface-stripe |
stripe · mollie · checkout-com · payment-subscriptions |