📄️ Arkos Router (new)
Available from v1.4.0-beta
📄️ Base Service Class
The BaseService class is a fundamental component that provides standardized CRUD (Create, Read, Update, Delete) operations for all models in your application. It serves as the foundation for Arkos's Prisma integration and can be extended for model-specific implementations.
📄️ Base Controller Class
The BaseController class provides standardized RESTful API endpoints for any given prisma model in your application. It follows a standard controller pattern that handles common CRUD operations through a consistent interface, reducing code duplication across the application.
📄️ Auth Service Object
The authService object provides comprehensive authentication functionality for your Arkos application. While Arkos handles authentication automatically behind the scenes, you may need direct access to the authentication methods in your business logic.
📄️ Catch Async Function
The catchAsync function is a utility function in the Arkos that wraps asynchronous request handlers and middleware to automatically catch errors and forward them to Express's error handling mechanism. This eliminates the need for repetitive try-catch blocks in every route handler, creating cleaner code and ensuring consistent error handling.
📄️ App Error Class
AppError is a specialized error class in the Arkos designed to standardize error handling across your application. It extends JavaScript's native Error class and adds properties that make it suitable for API and web application error management.
📄️ Arkos Configuration
Arkos provides a comprehensive configuration system that allows you to customize every aspect of your application. This reference covers all available configuration options for both arkos.init() and arkos.config.ts.
📄️ Email Service Class
This guide provides a detailed API reference for the EmailService class inside Arkos, which handles all email functionality in the system. Notice that this is a class used by Arkos under the hood and unless you really need to create your own instance and know what you doing you can create your own instance.
📄️ Request Handling Pipeline
In Arkos, each incoming request goes through a modular middleware pipeline that is dynamically constructed based on the Prisma model and its configuration. This allows you to hook into every stage of the request lifecycle without rewriting boilerplate or logic.
📄️ File Upload Controller
The fileUploadController provides direct access to Arkos's file upload functionality, allowing you to integrate file upload operations into custom routes with your own business logic and access control rules.
📄️ File Upload Services Function
The getFileUploadServices function provides a centralized way to handle file uploads in your Arkos application. It creates and returns specialized file uploader services for different file types (images, videos, documents, and general files), each preconfigured with appropriate size limits, file type validation, and processing capabilities.