fix(types): change the type guard on isCancel (#5595)

adimit · samavati · jasonsaayman · web-flow · commit 0dbb7fd4f61d · 2025-07-30T20:38:36.000+02:00
* fix(types): change the type guard on isCancel … to `CanceledError<any>`. This makes more sense as it reflects what `isCancel` is actually doing. In fact, if I'm not mistaken, the `Cancel` type is no longer in the project. It got removed in 7f12366. It should probably also be removed from the types. * Parameterize `CanceledError` in `isCancel` Thanks to @samavati for the suggestion. Co-authored-by: Ehsan Samavati <samaavaati@gmail.com> --------- Co-authored-by: Ehsan Samavati <samaavaati@gmail.com> Co-authored-by: Jay <jasonsaayman@gmail.com>
diff --git a/index.d.ts b/index.d.ts
@@ -443,6 +443,7 @@ export class AxiosError<T = unknown, D = any> extends Error {
 }
 
 export class CanceledError<T> extends AxiosError<T> {
+  readonly name: "CanceledError";
 }
 
 export type AxiosPromise<T = any> = Promise<AxiosResponse<T>>;
@@ -543,7 +544,7 @@ export function isAxiosError<T = any, D = any>(payload: any): payload is AxiosEr
 
 export function spread<T, R>(callback: (...args: T[]) => R): (array: T[]) => R;
 
-export function isCancel(value: any): value is Cancel;
+export function isCancel<T = any>(value: any): value is CanceledError<T>;
 
 export function all<T>(values: Array<T | Promise<T>>): Promise<T[]>;
 

Original file line number	Diff line number	Diff line change
`@@ -443,6 +443,7 @@ export class AxiosError<T = unknown, D = any> extends Error {`
`443`	`443`	`}`
`444`	`444`
`445`	`445`	`export class CanceledError<T> extends AxiosError<T> {`
	`446`	`+ readonly name: "CanceledError";`
`446`	`447`	`}`
`447`	`448`
`448`	`449`	`export type AxiosPromise<T = any> = Promise<AxiosResponse<T>>;`
`@@ -543,7 +544,7 @@ export function isAxiosError<T = any, D = any>(payload: any): payload is AxiosEr`
`543`	`544`
`544`	`545`	`export function spread<T, R>(callback: (...args: T[]) => R): (array: T[]) => R;`
`545`	`546`
`546`		`-export function isCancel(value: any): value is Cancel;`
	`547`	`+export function isCancel<T = any>(value: any): value is CanceledError<T>;`
`547`	`548`
`548`	`549`	`export function all<T>(values: Array<T \| Promise<T>>): Promise<T[]>;`
`549`	`550`