[data-reveal]{opacity:1!important;transform:none!important}

CONTRACTS

Let's build a large collection of interfaces

Discover a set of ready-to-use interfaces designed to easily enhance and extend the features of Antelopejs. A constantly evolving collection driven by an active community.

1 impl

API

A structured framework for building HTTP-based services using a clean, decorator-based approach to defining API endpoints and processing requests.

  • Decorator-based API controller definition
  • Flexible HTTP request and response handling
  • Advanced parameter processing and injection
1 impl

Data API

A framework for building data-driven APIs with a focus on CRUD operations, simplifying the creation of RESTful endpoints for your data models.

  • Specialized controllers for data model operations
  • Built-in support for filtering, sorting, and pagination
  • Field access control and data validation
1 impl

Auth

A flexible framework for implementing authentication and authorization using decorator-based approach to securing API endpoints and managing user sessions.

  • Decorator-based authentication for API endpoints
  • Comprehensive token handling and management
  • Parameter validation and authentication decorators
2 impls

Database

A database-agnostic query interface that brings Antelope Query Language (AQL), allowing consistent data operations across different database implementations.

  • Database-agnostic query interface (AQL)
  • Complete CRUD operations with type safety
  • Table and index management operations
1 impl

Database Decorators

A framework for implementing database operations using TypeScript decorators, offering a flexible, object-oriented approach to defining database tables and models.

  • TypeScript decorators for table and model definitions
  • Table modifiers for encryption, hashing, and localization
  • Integration with API controllers
1 impl

Rethink DB

A TypeScript-compatible interface for RethinkDB, providing access to RethinkDB functionality with a clean, promise-based API.

  • Simple RethinkDB query execution
  • Type-safe return values using TypeScript generics
  • Full access to RethinkDB query builder (r)
1 impl

Mongo DB

A direct interface to MongoDB client functionality, providing type-safe access to MongoDB operations for AntelopeJS applications.

  • Direct access to MongoDB client for native operations
  • Type-safe client access with TypeScript
  • Seamless integration with AntelopeJS ecosystem
1 impl

Stripe

A structured framework for integrating Stripe payment processing capabilities into your AntelopeJS applications with a clean API for payments and webhooks.

  • Complete payment intent management workflow
  • Real-time payment status monitoring
  • Secure webhook handling for Stripe events
1 impl

Redis

A promise-based interface for interacting with Redis, providing simplified access to Redis key-value storage, pub/sub messaging, and other Redis operations.

  • Promise-based API for Redis operations
  • Reliable connection management with auto-reconnection
  • Full access to all Redis commands and features
1 impl

Redis Scheduler

A robust interface for distributed task scheduling using Redis, enabling reliable execution of tasks across multiple application instances.

  • Distributed task scheduling across application cluster
  • Custom task handlers with typed task information
  • Automatic retries with configurable failure handling