📄️ Request Query Parameters Like Django
Using Double Underscore (__) for Filtering
📄️ 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.
📄️ The AppError 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.
📄️ The catchAsync Function
catchAsync 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.
📄️ The BaseService Class
The BaseService class is a fundamental component that provides standardized CRUD (Create, Read, Update, Delete) operations for all models in the application and is used by default behind the scenes in Arkos as a prisma models services factory. It serves as a base class that can be extended and customized for model-specific service implementations.
📄️ The BaseController 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.
📄️ The 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.
📄️ The EmailService 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.
📄️ File Uploader Services Guide
The getFileUploaderServices 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.
📄️ Default Supported Upload Files
Arkos provides built-in support for various file types across different categories. These default settings can be customized through configuration options.
📄️ Built-in Routers
Arkos provides several built-in routers that handle common API functionalities out of the box. This document outlines each router, its purpose, and how to configure it.