@api-buddy/types/dist/types/api/index.d.ts

Shared types for API Buddy

/**
 * API Response Types
 *
 * This file contains standard type definitions for API responses and requests.
 */
/**
 * Standard API response format for all API Buddy endpoints
 */
export interface ApiResponse<T = any> {
    /**
     * Indicates if the request was successful
     */
    success: boolean;
    /**
     * Response data (if successful)
     */
    data?: T;
    /**
     * Error message (if unsuccessful)
     */
    error?: string;
    /**
     * Optional metadata about the response
     */
    meta?: Record<string, any>;
}
/**
 * Standard error response format
 */
export interface ErrorResponse {
    /**
     * Error message
     */
    message: string;
    /**
     * Error code (if applicable)
     */
    code?: string | number;
    /**
     * Additional error details
     */
    details?: any;
}
/**
 * Pagination parameters for API requests
 */
export interface PaginationParams {
    /**
     * Page number (1-based)
     */
    page?: number;
    /**
     * Number of items per page
     */
    limit?: number;
    /**
     * Sort field
     */
    sortBy?: string;
    /**
     * Sort order (asc/desc)
     */
    sortOrder?: 'asc' | 'desc';
}
/**
 * Paginated response data
 */
export interface PaginatedResponse<T> {
    /**
     * Array of items for the current page
     */
    items: T[];
    /**
     * Total number of items across all pages
     */
    total: number;
    /**
     * Current page number
     */
    page: number;
    /**
     * Number of items per page
     */
    limit: number;
    /**
     * Total number of pages
     */
    totalPages: number;
    /**
     * Whether there are more pages available
     */
    hasMore: boolean;
}
//# sourceMappingURL=index.d.ts.map