feat(tag): 支持使用symbol作为tag

mengxinssfd · Apr 29, 2022 · 4986b71 · 4986b71
1 parent 955db3a
commit 4986b71
Show file tree

Hide file tree

Showing 3 changed files with 15 additions and 5 deletions.
diff --git a/__test__/AxiosRequestTemplate.test.ts b/__test__/AxiosRequestTemplate.test.ts
@@ -240,14 +240,19 @@ describe('AxiosRequestTemplate', () => {
     ]);
   });
   test('cancel with tag', async () => {
-    const req = new AxiosRequestTemplate(undefined, { tag: 'cancellable' });
+    const req = new AxiosRequestTemplate<CustomConfig>(undefined, { tag: 'cancellable' });
     const get = req.methodFactory('get');
     const res1 = get('/user', {}, { tag: 'irrevocable' });
     const res2 = get('/user');
     const res3 = get('/user');
+    const symbol = Symbol('cancel');
+    const symbol1 = Symbol('cancel');
+    const res4 = get('/user', {}, { tag: symbol });
+    const res5 = get('/user', {}, { tag: symbol1 });
     req.cancelWithTag('cancellable', 'cancel with tag');
+    req.cancelWithTag(symbol, 'cancel with tag symbol');
 
-    const res = await Promise.allSettled([res1, res2, res3]);
+    const res = await Promise.allSettled([res1, res2, res3, res4, res5]);
 
     expect(res).toEqual([
       {
@@ -256,6 +261,11 @@ describe('AxiosRequestTemplate', () => {
       },
       { status: 'rejected', reason: 'cancel with tag' },
       { status: 'rejected', reason: 'cancel with tag' },
+      { status: 'rejected', reason: 'cancel with tag symbol' },
+      {
+        status: 'fulfilled',
+        value: { code: 200, data: { id: 1, username: 'get' }, msg: 'success' },
+      },
     ]);
     req.cancelWithTag('default', 'cancel with tag');
   });

diff --git a/src/AxiosRequestTemplate.ts b/src/AxiosRequestTemplate.ts
@@ -19,7 +19,7 @@ export class AxiosRequestTemplate<CC extends CustomConfig = CustomConfig> {
 
   // cancel函数缓存
   protected readonly cancelerSet = new Set<Canceler>();
-  protected readonly tagCancelMap = new Map<string, Canceler[]>();
+  protected readonly tagCancelMap = new Map<CustomConfig['tag'], Canceler[]>();
 
   cancelCurrentRequest?: Canceler;
 
@@ -361,7 +361,7 @@ export class AxiosRequestTemplate<CC extends CustomConfig = CustomConfig> {
   }
 
   // 根据tag标签取消请求
-  cancelWithTag(tag: string, msg?: string) {
+  cancelWithTag(tag: CustomConfig['tag'], msg?: string) {
     const cancelers = this.tagCancelMap.get(tag);
     if (!cancelers) return;
     cancelers.forEach((canceler) => {

diff --git a/src/types.ts b/src/types.ts
@@ -34,7 +34,7 @@ export interface CustomConfig {
   // 缓存配置
   cache?: boolean | CustomCacheConfig;
   // 标签，用于取消请求
-  tag?: string;
+  tag?: string | symbol;
   // 失败重试次数
   retry?: number | RetryConfig;
 }