Axios Type Definitions — Axios'ning TypeScript type tizimi
Axios'ning TypeScript type tizimi: AxiosRequestConfig, InternalAxiosRequestConfig, AxiosResponse, AxiosError, Generics va Module Augmentation orqali tiplarni kengaytirish.
43-dars
Axios Type Definitions — Axios'ning TypeScript type tizimi
Axios o'z ichiga juda boy va mukammal TypeScript interfeyslarini oladi. Ular yordamida so'rov parametrlarini, serverdan keladigan javoblarni, xatoliklarni va hatto interceptor konfiguratsiyalarini 100% xavfsiz (type-safe) tarzda boshqarish mumkin.
1. Axios'ning asosiy Type'lari va Interfeyslari
A. AxiosRequestConfig va InternalAxiosRequestConfig
So'rov yuborishda ishlatiladigan konfiguratsiya obyektining ikkita asosiy turi mavjud:
AxiosRequestConfig: So'rovni yuborishdan oldin siz yozadigan boshlang'ich konfiguratsiya turi (baseURL,headers,paramsva boshqalar ixtiyoriy hisoblanadi).InternalAxiosRequestConfig: Request interceptor'ga kelib tushadigan to'liq shakllangan ichki config turi. Undaheadersva boshqa muhim maydonlar majburiy (required) holatga keltirilgan bo'ladi.
import { InternalAxiosRequestConfig } from 'axios';
import { apiClient } from './client';
apiClient.interceptors.request.use((config: InternalAxiosRequestConfig) => {
// config bu yerda to'liq tiplashtirilgan InternalAxiosRequestConfig hisoblanadi
// config.headers mavjudligi kafolatlangan
config.headers.set('X-Requested-With', 'XMLHttpRequest');
return config;
});
B. AxiosResponse<T>
Serverdan muvaffaqiyatli javob kelganda qaytadigan obyektning turi. E'tibor bering, Axios javobi faqatgina data'dan iborat emas, u o'z ichiga status, headers, config, statusText kabi maydonlarni ham oladi. Generik <T> esa serverdan keladigan response.data ma'lumotining real turini bildiradi.
import { AxiosResponse } from 'axios';
import { apiClient } from './client';
interface User {
id: number;
name: string;
email: string;
}
// response.data avtomatik ravishda User[] turiga ega bo'ladi
apiClient.get<User[]>('/users').then((response: AxiosResponse<User[]>) => {
console.log(response.status); // number: 200
console.log(response.data); // User[]
});
C. AxiosError<T>
Tarmoqda yoki serverda xatolik yuz berganda ushlanadigan xato turi. Generik <T> orqali backend xato berganda qaytaradigan JSON ma'lumotining turini (ApiErrorResponse) berish mumkin:
import { AxiosError } from 'axios';
import { apiClient } from './client';
interface ApiErrorResponse {
message: string;
errorCode: number;
details?: string[];
}
apiClient.get('/profile').catch((error: AxiosError<ApiErrorResponse>) => {
// error.response?.data tipi endi ApiErrorResponse bo'ladi
if (error.response) {
console.error(`Xato kodi: ${error.response.data.errorCode}`);
console.error(`Xabar: ${error.response.data.message}`);
} else {
console.error('Tarmoq xatosi:', error.message);
}
});
2. Generiklar (Generics) yordamida so'rovlarni tiplashtirish
Axios metodlari generiklar yordamida ishlaydi. Masalan, post yoki put metodlarida kutilayotgan javob turi va yuborilayotgan ma'lumot (payload) turini aniq belgilash mumkin:
import { apiClient } from './client';
interface CreateUserDto {
name: string;
email: string;
}
interface UserResponse {
id: number;
name: string;
email: string;
createdAt: string;
}
// POST so'rovini to'liq tiplashtirish:
export const createUser = async (data: CreateUserDto): Promise<UserResponse> => {
const response = await apiClient.post<UserResponse>('/users', data);
return response.data; // Tipi: UserResponse
};
3. Module Augmentation (Axios turlarini kengaytirish)
Ba'zida Axios'ning o'zining tiplarida ko'zda tutilmagan, lekin loyihada kerak bo'ladigan maxsus xususiyatlar (masalan, so'rov vaqtini o'lchash uchun metadata, yoki interceptor'ni o'tkazib yuborish uchun maxsus bayroqlar) talab etiladi.
TypeScript'da buni Module Augmentation orqali osongina kengaytirish mumkin.
Loyihaning istalgan .d.ts faylida (masalan, src/types/axios.d.ts yoki src/vite-env.d.ts) quyidagicha yozasiz:
// src/types/axios.d.ts
import 'axios';
// Axios ichki interfeyslarini o'zimizning maydonlar bilan kengaytiramiz
declare module 'axios' {
export interface InternalAxiosRequestConfig {
metadata?: {
startTime: number;
};
skipAuth?: boolean;
}
}
Endi interceptor'lar ichida config.metadata yoki config.skipAuth yozganingizda TypeScript hech qanday qizil xatolik chiqarmaydi va avtomatik taklif (autocomplete) beradi:
import { apiClient } from './client';
apiClient.interceptors.request.use((config) => {
// TypeScript bu maydonni to'liq taniydi!
config.metadata = {
startTime: Date.now(),
};
if (config.skipAuth) {
return config;
}
const token = localStorage.getItem('token');
if (token) {
config.headers.Authorization = `Bearer ${token}`;
}
return config;
});
4. Asosiy Type'larning qiyosiy jadvali
| Interface / Type | Qayerda ishlatiladi? | Asosiy vazifasi |
|---|---|---|
AxiosRequestConfig |
Foydalanuvchi so'rov yozayotganda | Ixtiyoriy boshlang'ich so'rov sozlamalari |
InternalAxiosRequestConfig |
Request interceptor parametrida | To'liq tayyorlangan, headers majburiy bo'lgan ichki config |
AxiosResponse<T> |
Javob qaytganda (.then / await) |
Server javobi, status, headers va generic <T> data turi |
AxiosError<T> |
Xatolik ushlanganda (.catch) |
Tarmoq yoki server xatoligi, generic <T> xato body turi |
AxiosInstance |
axios.create() natijasida |
Custom client obyektining tipi |
Xulosa
TypeScript muhitida Axios turlaridan to'g'ri foydalanish xatolarni dasturni ishga tushirishdan oldinoq (compile-time) aniqlash imkonini beradi. InternalAxiosRequestConfig, AxiosResponse<T>, AxiosError<T> va Module Augmentation kombinatsiyasi har qanday katta miqyosli loyihada xavfsiz va qulay API arxitekturasini yaratishga xizmat qiladi.