Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Improved type-safety for AxiosRequestConfig #2995

Merged
merged 6 commits into from Sep 5, 2021
Merged

Improved type-safety for AxiosRequestConfig #2995

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
66665ba
Improved type-safety for AxiosRequestConfig
carloschida Jun 2, 2020
1de4c18
Fixed tests
carloschida Jun 2, 2020
29cb27f
Merge branch 'master' into master
carloschida Jun 11, 2020
e780b6e
Merge branch 'master' into master
carloschida Jun 20, 2020
9f2c8f0
Merge branch 'master' into master
carloschida Oct 13, 2020
dd9d709
Merge branch 'master' into master
jasonsaayman Sep 5, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
22 changes: 11 additions & 11 deletions index.d.ts
View file
Open in desktop
Expand Up @@ -47,7 +47,7 @@ export interface TransitionalOptions{
clarifyTimeoutError: boolean;
}

export interface AxiosRequestConfig {
export interface AxiosRequestConfig<T = any> {
url?: string;
method?: Method;
baseURL?: string;
Expand All @@ -56,7 +56,7 @@ export interface AxiosRequestConfig {
headers?: any;
params?: any;
paramsSerializer?: (params: any) => string;
data?: any;
data?: T;
timeout?: number;
timeoutErrorMessage?: string;
withCredentials?: boolean;
Expand Down Expand Up @@ -85,7 +85,7 @@ export interface AxiosResponse<T = any> {
status: number;
statusText: string;
headers: any;
config: AxiosRequestConfig;
config: AxiosRequestConfig<T>;
request?: any;
}

Expand Down Expand Up @@ -142,14 +142,14 @@ export class Axios {
response: AxiosInterceptorManager<AxiosResponse>;
};
getUri(config?: AxiosRequestConfig): string;
request<T = any, R = AxiosResponse<T>> (config: AxiosRequestConfig): Promise<R>;
get<T = any, R = AxiosResponse<T>>(url: string, config?: AxiosRequestConfig): Promise<R>;
delete<T = any, R = AxiosResponse<T>>(url: string, config?: AxiosRequestConfig): Promise<R>;
head<T = any, R = AxiosResponse<T>>(url: string, config?: AxiosRequestConfig): Promise<R>;
options<T = any, R = AxiosResponse<T>>(url: string, config?: AxiosRequestConfig): Promise<R>;
post<T = any, R = AxiosResponse<T>>(url: string, data?: any, config?: AxiosRequestConfig): Promise<R>;
put<T = any, R = AxiosResponse<T>>(url: string, data?: any, config?: AxiosRequestConfig): Promise<R>;
patch<T = any, R = AxiosResponse<T>>(url: string, data?: any, config?: AxiosRequestConfig): Promise<R>;
request<T = any, R = AxiosResponse<T>> (config: AxiosRequestConfig<T>): Promise<R>;
get<T = any, R = AxiosResponse<T>>(url: string, config?: AxiosRequestConfig<T>): Promise<R>;
delete<T = any, R = AxiosResponse<T>>(url: string, config?: AxiosRequestConfig<T>): Promise<R>;
head<T = any, R = AxiosResponse<T>>(url: string, config?: AxiosRequestConfig<T>): Promise<R>;
options<T = any, R = AxiosResponse<T>>(url: string, config?: AxiosRequestConfig<T>): Promise<R>;
post<T = any, R = AxiosResponse<T>>(url: string, data?: T, config?: AxiosRequestConfig<T>): Promise<R>;
put<T = any, R = AxiosResponse<T>>(url: string, data?: T, config?: AxiosRequestConfig<T>): Promise<R>;
patch<T = any, R = AxiosResponse<T>>(url: string, data?: T, config?: AxiosRequestConfig<T>): Promise<R>;
}

export interface AxiosInstance extends Axios {
Expand Down
22 changes: 13 additions & 9 deletions test/typescript/axios.ts
View file
Open in desktop
Expand Up @@ -111,6 +111,10 @@ axios.patch('/user', { foo: 'bar' })
.catch(handleError);

// Typed methods
interface UserCreationDef {
name: string;
}

interface User {
id: number;
name: string;
Expand Down Expand Up @@ -138,7 +142,7 @@ axios.get<User>('/user', { params: { id: 12345 } })
axios.head<User>('/user')
.then(handleUserResponse)
.catch(handleError);

axios.options<User>('/user')
.then(handleUserResponse)
.catch(handleError);
Expand All @@ -147,19 +151,19 @@ axios.delete<User>('/user')
.then(handleUserResponse)
.catch(handleError);

axios.post<User>('/user', { foo: 'bar' })
axios.post<User>('/user', { name: 'foo', id: 1 })
.then(handleUserResponse)
.catch(handleError);

axios.post<User>('/user', { foo: 'bar' }, { headers: { 'X-FOO': 'bar' } })
axios.post<User>('/user', { name: 'foo', id: 1 }, { headers: { 'X-FOO': 'bar' } })
.then(handleUserResponse)
.catch(handleError);

axios.put<User>('/user', { foo: 'bar' })
axios.put<User>('/user', { name: 'foo', id: 1 })
.then(handleUserResponse)
.catch(handleError);

axios.patch<User>('/user', { foo: 'bar' })
axios.patch<User>('/user', { name: 'foo', id: 1 })
.then(handleUserResponse)
.catch(handleError);

Expand Down Expand Up @@ -189,19 +193,19 @@ axios.delete<User, string>('/user')
.then(handleStringResponse)
.catch(handleError);

axios.post<User, string>('/user', { foo: 'bar' })
axios.post<Partial<UserCreationDef>, string>('/user', { name: 'foo' })
.then(handleStringResponse)
.catch(handleError);

axios.post<User, string>('/user', { foo: 'bar' }, { headers: { 'X-FOO': 'bar' } })
axios.post<Partial<UserCreationDef>, string>('/user', { name: 'foo' }, { headers: { 'X-FOO': 'bar' } })
.then(handleStringResponse)
.catch(handleError);

axios.put<User, string>('/user', { foo: 'bar' })
axios.put<Partial<UserCreationDef>, string>('/user', { name: 'foo' })
.then(handleStringResponse)
.catch(handleError);

axios.patch<User, string>('/user', { foo: 'bar' })
axios.patch<Partial<UserCreationDef>, string>('/user', { name: 'foo' })
.then(handleStringResponse)
.catch(handleError);

Expand Down