Module Augmentation — Axios konfiguratsiyasiga custom TypeScript property qo'shish
TypeScript Module Augmentation orqali AxiosRequestConfig va InternalAxiosRequestConfig interfeyslarini kengaytirish: metadata, skipGlobalErrorToast va retryCount xususiyatlari.
53-dars
Module Augmentation — Axios konfiguratsiyasiga custom TypeScript property qo'shish
Request interceptor ichida so'rov boshlangan vaqtni saqlash uchun config.metadata = { startTime: Date.now() } yoki maxsus boshqaruv bayroqlaridan foydalanishga to'g'ri keladi.
Lekin agar siz oddiy TypeScript muhitida config.metadata deb yozsangiz, IDE yoki TypeScript kompilyatori darhol qizil xatolik chiqaradi:
Property 'metadata' does not exist on type 'InternalAxiosRequestConfig'.
Buning sababi — Axios'ning rasmiy type ta'riflarida metadata degan xususiyat oldindan mavjud emas. Ushbu muammoni to'liq type-safe tarzda hal qilish va o'zimizga kerakli bo'lgan ixtiyoriy maydonlarni Axios tiplariga qo'shish uchun Module Augmentation (Modulni kengaytirish) texnikasidan foydalanamiz.
1. Module Augmentation qanday ishlatiladi?
TypeScript'da uchinchi tomon kutubxonalarining ichki interfeyslarini xavfsiz kengaytirish uchun declare module 'axios' blokidan foydalaniladi.
Loyihangizda global tiplar uchun mo'ljallangan deklaratsiya fayliga (masalan, src/types/axios.d.ts yoki src/vite-env.d.ts) quyidagi kodni yozasiz:
// src/types/axios.d.ts
import 'axios';
// Axios modulini yangi xususiyatlar bilan kengaytiramiz
declare module 'axios' {
// 1. So'rov chaqirilganda ishlatiladigan config uchun custom maydonlar
export interface AxiosRequestConfig {
metadata?: {
startTime: number;
};
skipGlobalErrorToast?: boolean;
retryCount?: number;
}
// 2. Interceptor'ga kelib tushadigan Internal config uchun ham kengaytiramiz
export interface InternalAxiosRequestConfig {
metadata?: {
startTime: number;
};
skipGlobalErrorToast?: boolean;
retryCount?: number;
}
}
[!IMPORTANT] Ushbu
.d.tsfayl boshida albattaimport 'axios';qatori yozilishi shart. Aks holda TypeScript Axios'ning butun asl kutubxona tiplarini yo'qotib, uni noldan yangi modul deb hisoblab yuboradi.import 'axios'esa mavjud modulni kengaytirish (augmentation) ekanligini bildiradi.
2. Amalda qo'llash: Performance (Vaqtni o'lchash) Interceptor'i
Endi yuqoridagi kengaytmani o'zimizning amaldagi interceptor'larimizda hech qanday qizil xatolarsiz bemalol ishlatishimiz mumkin:
import { apiClient } from './client';
import { InternalAxiosRequestConfig, AxiosResponse, AxiosError } from 'axios';
// --- 1. Request Interceptor: Vaqtni yozib qo'yamiz ---
apiClient.interceptors.request.use(
(config: InternalAxiosRequestConfig) => {
// TypeScript endi config.metadata mavjudligini mukammal biladi!
config.metadata = {
startTime: Date.now(),
};
return config;
},
(error: AxiosError) => Promise.reject(error)
);
// --- 2. Response Interceptor: Sarflangan vaqtni hisoblaymiz ---
apiClient.interceptors.response.use(
(response: AxiosResponse) => {
const config = response.config;
if (config.metadata?.startTime) {
const duration = Date.now() - config.metadata.startTime;
console.log(`[API Performance] ${config.url} — ${duration}ms vaqt oldi`);
}
return response;
},
(error: AxiosError) => {
const config = error.config;
if (config?.metadata?.startTime) {
const duration = Date.now() - config.metadata.startTime;
console.warn(`[API Error Performance] ${config.url} — ${duration}ms ichida xato bilan tugadi`);
}
return Promise.reject(error);
}
);
3. Modulni kengaytirish orqali yana nimalar qilish mumkin?
Module Augmentation yordamida faqatgina metadata emas, balki loyihangiz talablaridan kelib chiqqan holda ko'plab amaliy sozlamalarni kiritish mumkin:
A. skipGlobalErrorToast (Xabarnomani chetlab o'tish)
Ba'zi fonda bajariladigan so'rovlarda global qizil xato xabarnomasi (toast/modal) chiqmasligi kerak:
// So'rov yuborishda:
apiClient.get('/background-analytics', { skipGlobalErrorToast: true });
// Response Interceptor ichida:
apiClient.interceptors.response.use(
(res) => res,
(error: AxiosError) => {
if (!error.config?.skipGlobalErrorToast) {
toast.error('Xatolik yuz berdi!');
}
return Promise.reject(error);
}
);
B. retryCount (Qayta urinishlar soni)
Tarmoq uzilganda so'rovni necha marta avtomatik qayta yuborish kerakligini har bir so'rov uchun alohida belgilash:
apiClient.get('/critical-data', { retryCount: 3 });
4. Module Augmentation qoidalari va eng yaxshi amaliyotlar
| Qoida | Sababi | Tavsiya |
|---|---|---|
import 'axios'; yozish |
Mavjud tiplarni to'liq saqlab qolish | Faylning birinchi qatoriga doimo yozing |
| Ikkala interfeysni kengaytirish | AxiosRequestConfig va InternalAxiosRequestConfig alohida ishlatiladi |
Har ikkala interfeysga ham maydonlarni qo'shing |
Ixtiyoriy (?) qilib belgilash |
Barcha so'rovlarda bu maydonlar bo'lmasligi mumkin | metadata?: ..., skipAuth?: boolean |
tsconfig.json ga kiritish |
TypeScript declaration faylini tanishi uchun | include qismida "src/**/*.d.ts" bo'lishini tekshiring |
Xulosa
TypeScript Module Augmentation — tashqi kutubxonalarni o'z ehtiyojlarimizga moslashtirishning eng professional va toza usulidir. U any yoki (config as any).metadata kabi nosog'lom "hack"lardan butunlay xalos etib, 100% type-safe va IDE tomonidan to'liq qo'llab-quvvatlanadigan arxitektura yaratishga imkon beradi.