Series: Axios Lesson 46

AxiosInstance — Custom instance'larni TypeScript bilan ishlatish

AxiosInstance interfeysi: Dependency Injection orqali testlash va moslashuvchanlik, response.data unwrap muammosi va Custom API Wrapper yaratish.

46-dars

AxiosInstance — Custom instance'larni TypeScript bilan ishlatish

Biz axios.create() orqali shaxsiy instansiya yaratganimizda, TypeScript unga avtomatik ravishda AxiosInstance turini (tipini) biriktiradi. Ushbu interfeys get, post, interceptors va defaults kabi barcha kerakli xususiyatlarni o'zida mujassam etadi.


1. AxiosInstance dan Dependency Injection usulida foydalanish

Yirik loyihalarda servislar faqat bitta muayyan instansiyaga "qotib" qolmasligi uchun, AxiosInstance obyektini funksiya parametrida qabul qilish (Dependency Injection) juda yaxshi amaliyot hisoblanadi. Bu ayniqsa birlik testlarini (Unit Tests) yozishda va turli muhitlar (ishlab chiqish, test, staging) o'rtasida oson almashishda qo'l keladi.

import axios, { AxiosInstance } from 'axios';
import { User } from '../types';

// 1. Asosiy va Mock instansiyalarni yaratamiz
export const mainApiClient = axios.create({ baseURL: 'https://api.main.com' });
export const mockApiClient = axios.create({ baseURL: 'http://localhost:3000' });

// 2. Servis funksiyasi qaysi instansiya berilsa, shundan foydalanadi
export const fetchUsers = async (client: AxiosInstance): Promise<User[]> => {
  const response = await client.get<User[]>('/users');
  return response.data;
};

// 3. Ishlatilishi:
// Haqiqiy serverdan olish
const realUsers = await fetchUsers(mainApiClient);

// Test muhitida mock serverdan olish
const testUsers = await fetchUsers(mockApiClient);

2. Eng keng tarqalgan muammo: Interceptor'da response.data qaytarish va TypeScript tiplarining buzilishi

Ba'zi dasturchilar response interceptor ichida kodni qisqartirish uchun to'g'ridan-to'g'ri return response.data; qilishni afzal ko'rishadi. Lekin TypeScript bilan ishlaganda bu jiddiy muammo tug'diradi!

Agar siz interceptor'da return response.data qilsangiz ham, TypeScript buni sezmaydi va baribir funksiyangiz Promise<AxiosResponse<T>> qaytaryapti deb hisoblaydi:

// ❌ Muammoli holat:
apiClient.interceptors.response.use((res) => res.data); // data qaytaryapmiz

// Lekin TypeScript hali ham res ni AxiosResponse deb o'ylaydi:
const res = await apiClient.get<User>('/user/1');

console.log(res.data); 
// ⚠️ XATO! Aslida res ning o'zi User obyektiga aylanib bo'lgan,
// lekin TypeScript res.data ni qidirib xatolik chiqaradi yoki undefined qaytaradi!

3. Yechim: AxiosInstance ni O'zimizning Type bilan o'rash (Custom API Wrapper)

Interceptor'da response.data qaytarilgan taqdirda TypeScript buni to'g'ri tushunishi uchun, AxiosInstance metodlarini qaytadan tiplashtirib chiqish lozim. Eng xavfsiz va qulay yo'l — Custom API Wrapper obyekti yaratishdir.

// src/api/ApiWrapper.ts
import axios, { AxiosInstance, AxiosRequestConfig } from 'axios';

// 1. Standart instansiya yaratamiz
const apiClient: AxiosInstance = axios.create({
  baseURL: 'https://api.mysite.com',
  timeout: 10000,
});

// 2. Interceptor'da to'g'ridan-to'g'ri data ni qaytaramiz
apiClient.interceptors.response.use(
  (response) => response.data,
  (error) => Promise.reject(error)
);

// 3. TYPESCRIPT UCHUN WRAPPER YARATAMIZ
// Endi barcha chaqiruvlar faqat sof Promise<T> qaytarishini kafolatlaymiz
export const ApiWrapper = {
  get: <T>(url: string, config?: AxiosRequestConfig): Promise<T> => {
    return apiClient.get(url, config);
  },
  post: <T, D = any>(url: string, data?: D, config?: AxiosRequestConfig): Promise<T> => {
    return apiClient.post(url, data, config);
  },
  put: <T, D = any>(url: string, data?: D, config?: AxiosRequestConfig): Promise<T> => {
    return apiClient.put(url, data, config);
  },
  delete: <T>(url: string, config?: AxiosRequestConfig): Promise<T> => {
    return apiClient.delete(url, config);
  },
};

4. Service qatlamida ApiWrapper'ni qo'llash

Endi kodimiz ancha ixcham, o'qilishi oson va TypeScript tomonidan 100% to'g'ri aniqlanadi:

// src/services/productService.ts
import { ApiWrapper } from '../api/ApiWrapper';
import { Product } from '../types';

export const ProductService = {
  // Hech qanday "res.data" yozishga hojat yo'q,
  // hamma narsa toza Promise<Product[]> bo'lib keladi
  getAll: (): Promise<Product[]> => {
    return ApiWrapper.get<Product[]>('/products');
  },

  create: (newProduct: Partial<Product>): Promise<Product> => {
    return ApiWrapper.post<Product, Partial<Product>>('/products', newProduct);
  }
};

5. AxiosInstance to'g'ridan-to'g'ri vs ApiWrapper taqqoslovi

Xususiyat To'g'ridan-to'g'ri AxiosInstance Custom ApiWrapper
Qaytaradigan qiymat Promise<AxiosResponse<T>> Promise<T> (faqat sof ma'lumot)
Interceptor'da res.data TypeScript tiplari buziladi TypeScript turlari 100% to'g'ri ishlaydi
Kod hajmi servisda Har safar res.data deb ajratish kerak To'g'ridan-to'g'ri return ApiWrapper.get<T>()
Moslashuvchanlik To'liq Axios API'ga kirish bor Faqat wrapper taqdim etgan metodlar ishlaydi

Xulosa

AxiosInstance turidan foydalanish API mantiqini modulli va sinovdan o'tkazishga mos (testable) qiladi. Agar loyihada so'rov natijasini soddalashtirish uchun response.data ni interceptor orqali to'g'ridan-to'g'ri qaytarish qaroriga kelsangiz, TypeScript bilan yuzaga keladigan ziddiyatlarni bartaraf etish uchun ApiWrapper pattern'i eng optimal yechimdir.