mirror of
https://github.com/tenrok/axios.git
synced 2026-06-08 17:22:34 +03:00
Fix/typescript tests (#5375)
* chore(ci): Add release-it script; * chore(ci): add `release:no-npm` script to release the package without making an npm release; * fix(test): fixed `d.ts` typings; refactor(test): refactor typescript tests;
This commit is contained in:
@@ -14,6 +14,16 @@ const __dirname = path.dirname(fileURLToPath(import.meta.url));
|
||||
|
||||
const exec = util.promisify(cp.exec);
|
||||
|
||||
const spawn = (command, args) => new Promise((resolve, reject) => {
|
||||
cp.spawn(command, args, {
|
||||
shell : true,
|
||||
stdio: 'inherit'
|
||||
}).once('error', reject).on(
|
||||
'close',
|
||||
(code) => code ? reject(new Error(`Exit code ${code}`)) : resolve()
|
||||
);
|
||||
});
|
||||
|
||||
const {Axios} = axiosFactory;
|
||||
|
||||
const ignoreList = ['default'];
|
||||
@@ -134,4 +144,40 @@ describe('module', function () {
|
||||
await exec(`npm test --prefix ${pkgPath}`, {});
|
||||
});
|
||||
});
|
||||
|
||||
describe('typings', () => {
|
||||
describe('ESM', ()=> {
|
||||
const pkgPath = path.join(__dirname, './typings/esm');
|
||||
|
||||
after(async ()=> {
|
||||
await remove(path.join(pkgPath, './node_modules'));
|
||||
});
|
||||
|
||||
it('should pass types check', async function () {
|
||||
this.timeout(30000);
|
||||
|
||||
await spawn(`npm test --prefix ${pkgPath}`, [], {
|
||||
shell : true,
|
||||
stdio: 'pipe'
|
||||
});
|
||||
});
|
||||
});
|
||||
|
||||
describe('CommonJS', ()=> {
|
||||
const pkgPath = path.join(__dirname, './typings/cjs');
|
||||
|
||||
after(async ()=> {
|
||||
await remove(path.join(pkgPath, './node_modules'));
|
||||
});
|
||||
|
||||
it('should pass types check', async function () {
|
||||
this.timeout(30000);
|
||||
|
||||
await spawn(`npm test --prefix ${pkgPath}`, [], {
|
||||
shell : true,
|
||||
stdio: 'pipe'
|
||||
});
|
||||
});
|
||||
});
|
||||
});
|
||||
});
|
||||
|
||||
@@ -0,0 +1,443 @@
|
||||
import axios = require('axios');
|
||||
|
||||
const config: axios.AxiosRequestConfig = {
|
||||
url: '/user',
|
||||
method: 'get',
|
||||
baseURL: 'https://api.example.com/',
|
||||
transformRequest: (data: any) => '{"foo":"bar"}',
|
||||
transformResponse: [
|
||||
(data: any) => ({ baz: 'qux' })
|
||||
],
|
||||
headers: { 'X-FOO': 'bar' },
|
||||
params: { id: 12345 },
|
||||
paramsSerializer: {
|
||||
indexes: true,
|
||||
encode: (value: any) => value,
|
||||
serialize: (value: Record<string, any>, options?: axios.ParamsSerializerOptions) => String(value)
|
||||
},
|
||||
data: { foo: 'bar' },
|
||||
timeout: 10000,
|
||||
withCredentials: true,
|
||||
auth: {
|
||||
username: 'janedoe',
|
||||
password: 's00pers3cret'
|
||||
},
|
||||
responseType: 'json',
|
||||
xsrfCookieName: 'XSRF-TOKEN',
|
||||
xsrfHeaderName: 'X-XSRF-TOKEN',
|
||||
onUploadProgress: (progressEvent: axios.AxiosProgressEvent) => {},
|
||||
onDownloadProgress: (progressEvent: axios.AxiosProgressEvent) => {},
|
||||
maxContentLength: 2000,
|
||||
maxBodyLength: 2000,
|
||||
validateStatus: (status: number) => status >= 200 && status < 300,
|
||||
maxRedirects: 5,
|
||||
proxy: {
|
||||
host: '127.0.0.1',
|
||||
port: 9000
|
||||
},
|
||||
cancelToken: new axios.CancelToken((cancel: axios.Canceler) => {})
|
||||
};
|
||||
|
||||
const nullValidateStatusConfig: axios.AxiosRequestConfig = {
|
||||
validateStatus: null
|
||||
};
|
||||
|
||||
const undefinedValidateStatusConfig: axios.AxiosRequestConfig = {
|
||||
validateStatus: undefined
|
||||
};
|
||||
|
||||
const handleResponse = (response: axios.AxiosResponse) => {
|
||||
console.log(response.data);
|
||||
console.log(response.status);
|
||||
console.log(response.statusText);
|
||||
console.log(response.headers);
|
||||
console.log(response.config);
|
||||
};
|
||||
|
||||
const handleError = (error: axios.AxiosError) => {
|
||||
if (error.response) {
|
||||
console.log(error.response.data);
|
||||
console.log(error.response.status);
|
||||
console.log(error.response.headers);
|
||||
} else {
|
||||
console.log(error.message);
|
||||
}
|
||||
};
|
||||
|
||||
axios(config)
|
||||
.then(handleResponse)
|
||||
.catch(handleError);
|
||||
|
||||
axios.get('/user?id=12345')
|
||||
.then(handleResponse)
|
||||
.catch(handleError);
|
||||
|
||||
axios.get('/user', { params: { id: 12345 } })
|
||||
.then(handleResponse)
|
||||
.catch(handleError);
|
||||
|
||||
axios.head('/user')
|
||||
.then(handleResponse)
|
||||
.catch(handleError);
|
||||
|
||||
axios.options('/user')
|
||||
.then(handleResponse)
|
||||
.catch(handleError);
|
||||
|
||||
axios.delete('/user')
|
||||
.then(handleResponse)
|
||||
.catch(handleError);
|
||||
|
||||
axios.post('/user', { foo: 'bar' })
|
||||
.then(handleResponse)
|
||||
.catch(handleError);
|
||||
|
||||
axios.post('/user', { foo: 'bar' }, { headers: { 'X-FOO': 'bar' } })
|
||||
.then(handleResponse)
|
||||
.catch(handleError);
|
||||
|
||||
axios.put('/user', { foo: 'bar' })
|
||||
.then(handleResponse)
|
||||
.catch(handleError);
|
||||
|
||||
axios.patch('/user', { foo: 'bar' })
|
||||
.then(handleResponse)
|
||||
.catch(handleError);
|
||||
|
||||
// Typed methods
|
||||
interface UserCreationDef {
|
||||
name: string;
|
||||
}
|
||||
|
||||
interface User {
|
||||
id: number;
|
||||
name: string;
|
||||
}
|
||||
|
||||
// with default axios.AxiosResponse<T> result
|
||||
|
||||
const handleUserResponse = (response: axios.AxiosResponse<User>) => {
|
||||
console.log(response.data.id);
|
||||
console.log(response.data.name);
|
||||
console.log(response.status);
|
||||
console.log(response.statusText);
|
||||
console.log(response.headers);
|
||||
console.log(response.config);
|
||||
};
|
||||
|
||||
axios.get<User>('/user?id=12345')
|
||||
.then(handleUserResponse)
|
||||
.catch(handleError);
|
||||
|
||||
axios.get<User>('/user', { params: { id: 12345 } })
|
||||
.then(handleUserResponse)
|
||||
.catch(handleError);
|
||||
|
||||
axios.head<User>('/user')
|
||||
.then(handleUserResponse)
|
||||
.catch(handleError);
|
||||
|
||||
axios.options<User>('/user')
|
||||
.then(handleUserResponse)
|
||||
.catch(handleError);
|
||||
|
||||
axios.delete<User>('/user')
|
||||
.then(handleUserResponse)
|
||||
.catch(handleError);
|
||||
|
||||
axios.post<User>('/user', { name: 'foo', id: 1 })
|
||||
.then(handleUserResponse)
|
||||
.catch(handleError);
|
||||
|
||||
axios.post<User>('/user', { name: 'foo', id: 1 }, { headers: { 'X-FOO': 'bar' } })
|
||||
.then(handleUserResponse)
|
||||
.catch(handleError);
|
||||
|
||||
axios.put<User>('/user', { name: 'foo', id: 1 })
|
||||
.then(handleUserResponse)
|
||||
.catch(handleError);
|
||||
|
||||
axios.patch<User>('/user', { name: 'foo', id: 1 })
|
||||
.then(handleUserResponse)
|
||||
.catch(handleError);
|
||||
|
||||
// (Typed methods) with custom response type
|
||||
|
||||
const handleStringResponse = (response: string) => {
|
||||
console.log(response);
|
||||
};
|
||||
|
||||
axios.get<User, string>('/user?id=12345')
|
||||
.then(handleStringResponse)
|
||||
.catch(handleError);
|
||||
|
||||
axios.get<User, string>('/user', { params: { id: 12345 } })
|
||||
.then(handleStringResponse)
|
||||
.catch(handleError);
|
||||
|
||||
axios.head<User, string>('/user')
|
||||
.then(handleStringResponse)
|
||||
.catch(handleError);
|
||||
|
||||
axios.options<User, string>('/user')
|
||||
.then(handleStringResponse)
|
||||
.catch(handleError);
|
||||
|
||||
axios.delete<User, string>('/user')
|
||||
.then(handleStringResponse)
|
||||
.catch(handleError);
|
||||
|
||||
axios.post<Partial<UserCreationDef>, string>('/user', { name: 'foo' })
|
||||
.then(handleStringResponse)
|
||||
.catch(handleError);
|
||||
|
||||
axios.post<Partial<UserCreationDef>, string>('/user', { name: 'foo' }, { headers: { 'X-FOO': 'bar' } })
|
||||
.then(handleStringResponse)
|
||||
.catch(handleError);
|
||||
|
||||
axios.put<Partial<UserCreationDef>, string>('/user', { name: 'foo' })
|
||||
.then(handleStringResponse)
|
||||
.catch(handleError);
|
||||
|
||||
axios.patch<Partial<UserCreationDef>, string>('/user', { name: 'foo' })
|
||||
.then(handleStringResponse)
|
||||
.catch(handleError);
|
||||
|
||||
axios.request<User, string>({
|
||||
method: 'get',
|
||||
url: '/user?id=12345'
|
||||
})
|
||||
.then(handleStringResponse)
|
||||
.catch(handleError);
|
||||
|
||||
// Instances
|
||||
|
||||
const instance1: axios.AxiosInstance = axios.create();
|
||||
const instance2: axios.AxiosInstance = axios.create(config);
|
||||
|
||||
instance1(config)
|
||||
.then(handleResponse)
|
||||
.catch(handleError);
|
||||
|
||||
instance1.request(config)
|
||||
.then(handleResponse)
|
||||
.catch(handleError);
|
||||
|
||||
instance1.get('/user?id=12345')
|
||||
.then(handleResponse)
|
||||
.catch(handleError);
|
||||
|
||||
instance1.options('/user')
|
||||
.then(handleResponse)
|
||||
.catch(handleError);
|
||||
|
||||
instance1.get('/user', { params: { id: 12345 } })
|
||||
.then(handleResponse)
|
||||
.catch(handleError);
|
||||
|
||||
instance1.post('/user', { foo: 'bar' })
|
||||
.then(handleResponse)
|
||||
.catch(handleError);
|
||||
|
||||
instance1.post('/user', { foo: 'bar' }, { headers: { 'X-FOO': 'bar' } })
|
||||
.then(handleResponse)
|
||||
.catch(handleError);
|
||||
|
||||
// Defaults
|
||||
|
||||
axios.defaults.headers['X-FOO'];
|
||||
|
||||
axios.defaults.baseURL = 'https://api.example.com/';
|
||||
axios.defaults.headers.common['Accept'] = 'application/json';
|
||||
axios.defaults.headers.post['X-FOO'] = 'bar';
|
||||
axios.defaults.timeout = 2500;
|
||||
|
||||
instance1.defaults.baseURL = 'https://api.example.com/';
|
||||
instance1.defaults.headers.common['Accept'] = 'application/json';
|
||||
instance1.defaults.headers.post['X-FOO'] = 'bar';
|
||||
instance1.defaults.timeout = 2500;
|
||||
|
||||
// axios create defaults
|
||||
|
||||
axios.create({ headers: { foo: 'bar' } });
|
||||
axios.create({ headers: { common: { foo: 'bar' } } });
|
||||
axios.create({
|
||||
headers: {
|
||||
'Content-Type': 'application/json',
|
||||
},
|
||||
formSerializer: {
|
||||
indexes: null,
|
||||
},
|
||||
paramsSerializer: {
|
||||
indexes: null,
|
||||
},
|
||||
});
|
||||
|
||||
// Interceptors
|
||||
|
||||
const requestInterceptorId: number = axios.interceptors.request.use(
|
||||
(config: axios.AxiosRequestConfig) => config,
|
||||
(error: any) => Promise.reject(error)
|
||||
);
|
||||
|
||||
axios.interceptors.request.eject(requestInterceptorId);
|
||||
|
||||
axios.interceptors.request.use(
|
||||
(config: axios.AxiosRequestConfig) => Promise.resolve(config),
|
||||
(error: any) => Promise.reject(error)
|
||||
);
|
||||
|
||||
axios.interceptors.request.use((config: axios.AxiosRequestConfig) => config);
|
||||
axios.interceptors.request.use((config: axios.AxiosRequestConfig) => Promise.resolve(config));
|
||||
|
||||
const responseInterceptorId: number = axios.interceptors.response.use(
|
||||
(response: axios.AxiosResponse) => response,
|
||||
(error: any) => Promise.reject(error)
|
||||
);
|
||||
|
||||
axios.interceptors.response.eject(responseInterceptorId);
|
||||
|
||||
axios.interceptors.response.use(
|
||||
(response: axios.AxiosResponse) => Promise.resolve(response),
|
||||
(error: any) => Promise.reject(error)
|
||||
);
|
||||
|
||||
const voidRequestInterceptorId = axios.interceptors.request.use(
|
||||
// @ts-expect-error -- Must return an axios.AxiosRequestConfig (or throw)
|
||||
(_response) => {},
|
||||
(error: any) => Promise.reject(error)
|
||||
);
|
||||
const voidResponseInterceptorId = axios.interceptors.response.use(
|
||||
// @ts-expect-error -- Must return an axios.AxiosResponse (or throw)
|
||||
(_response) => {},
|
||||
(error: any) => Promise.reject(error)
|
||||
);
|
||||
axios.interceptors.request.eject(voidRequestInterceptorId);
|
||||
axios.interceptors.response.eject(voidResponseInterceptorId);
|
||||
|
||||
axios.interceptors.response.use((response: axios.AxiosResponse) => response);
|
||||
axios.interceptors.response.use((response: axios.AxiosResponse) => Promise.resolve(response));
|
||||
|
||||
axios.interceptors.request.clear();
|
||||
axios.interceptors.response.clear();
|
||||
|
||||
// Adapters
|
||||
|
||||
const adapter: axios.AxiosAdapter = (config: axios.AxiosRequestConfig) => {
|
||||
const response: axios.AxiosResponse = {
|
||||
data: { foo: 'bar' },
|
||||
status: 200,
|
||||
statusText: 'OK',
|
||||
headers: { 'X-FOO': 'bar' },
|
||||
config
|
||||
};
|
||||
return Promise.resolve(response);
|
||||
};
|
||||
|
||||
axios.defaults.adapter = adapter;
|
||||
|
||||
// axios.all
|
||||
|
||||
const promises = [
|
||||
Promise.resolve(1),
|
||||
Promise.resolve(2)
|
||||
];
|
||||
|
||||
const promise: Promise<number[]> = axios.all(promises);
|
||||
|
||||
// axios.spread
|
||||
|
||||
const fn1 = (a: number, b: number, c: number) => `${a}-${b}-${c}`;
|
||||
const fn2: (arr: number[]) => string = axios.spread(fn1);
|
||||
|
||||
// Promises
|
||||
|
||||
axios.get('/user')
|
||||
.then((response: axios.AxiosResponse) => 'foo')
|
||||
.then((value: string) => {});
|
||||
|
||||
axios.get('/user')
|
||||
.then((response: axios.AxiosResponse) => Promise.resolve('foo'))
|
||||
.then((value: string) => {});
|
||||
|
||||
axios.get('/user')
|
||||
.then((response: axios.AxiosResponse) => 'foo', (error: any) => 'bar')
|
||||
.then((value: string) => {});
|
||||
|
||||
axios.get('/user')
|
||||
.then((response: axios.AxiosResponse) => 'foo', (error: any) => 123)
|
||||
.then((value: string | number) => {});
|
||||
|
||||
axios.get('/user')
|
||||
.catch((error: any) => 'foo')
|
||||
.then((value) => {});
|
||||
|
||||
axios.get('/user')
|
||||
.catch((error: any) => Promise.resolve('foo'))
|
||||
.then((value) => {});
|
||||
|
||||
// axios.Cancellation
|
||||
|
||||
const source: axios.CancelTokenSource = axios.CancelToken.source();
|
||||
|
||||
axios.get('/user', {
|
||||
cancelToken: source.token
|
||||
}).catch((thrown: axios.AxiosError | axios.Cancel) => {
|
||||
if (axios.isCancel(thrown)) {
|
||||
const cancel: axios.Cancel = thrown;
|
||||
console.log(cancel.message);
|
||||
}
|
||||
});
|
||||
|
||||
source.cancel('Operation has been axios.Canceled.');
|
||||
|
||||
// axios.AxiosError
|
||||
|
||||
axios.get('/user')
|
||||
.catch((error) => {
|
||||
if (axios.isAxiosError(error)) {
|
||||
const axiosError: axios.AxiosError = error;
|
||||
}
|
||||
});
|
||||
|
||||
// FormData
|
||||
|
||||
axios.toFormData({x: 1}, new FormData());
|
||||
|
||||
// AbortSignal
|
||||
|
||||
axios.get('/user', {signal: new AbortController().signal});
|
||||
|
||||
// AxiosHeaders methods
|
||||
|
||||
axios.get('/user', {
|
||||
transformRequest: (data, headers) => {
|
||||
headers.setContentType('text/plain');
|
||||
headers['Foo'] = 'bar';
|
||||
},
|
||||
|
||||
transformResponse: (data, headers) => {
|
||||
headers.has('foo');
|
||||
}
|
||||
});
|
||||
|
||||
// Max Rate
|
||||
|
||||
axios.get('/user', {
|
||||
maxRate: 1000
|
||||
});
|
||||
|
||||
axios.get('/user', {
|
||||
maxRate: [1000, 1000],
|
||||
});
|
||||
|
||||
// Node progress
|
||||
|
||||
axios.get('/user', {
|
||||
onUploadProgress: (e: axios.AxiosProgressEvent) => {
|
||||
console.log(e.loaded);
|
||||
console.log(e.total);
|
||||
console.log(e.progress);
|
||||
console.log(e.rate);
|
||||
}
|
||||
});
|
||||
@@ -0,0 +1,20 @@
|
||||
{
|
||||
"name": "commonjs-typings-test",
|
||||
"version": "1.0.0",
|
||||
"description": "",
|
||||
"main": "index.js",
|
||||
"scripts": {
|
||||
"test": "npm i --no-save --no-package-lock && tsc -v && npm run test:types",
|
||||
"test:types": "tsc --noEmit"
|
||||
},
|
||||
"keywords": [],
|
||||
"author": "",
|
||||
"license": "MIT",
|
||||
"dependencies": {
|
||||
"@types/node": "^18.11.3",
|
||||
"axios": "file:../../../.."
|
||||
},
|
||||
"devDependencies": {
|
||||
"typescript": "^4.9.4"
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,6 @@
|
||||
{
|
||||
"compilerOptions": {
|
||||
"checkJs": true,
|
||||
"module": "node16"
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,563 @@
|
||||
import axios, {
|
||||
AxiosRequestConfig,
|
||||
AxiosHeaders,
|
||||
AxiosRequestHeaders,
|
||||
AxiosResponseHeaders,
|
||||
RawAxiosRequestHeaders,
|
||||
AxiosResponse,
|
||||
AxiosError,
|
||||
AxiosInstance,
|
||||
AxiosAdapter,
|
||||
Cancel,
|
||||
CancelTokenSource,
|
||||
Canceler,
|
||||
AxiosProgressEvent,
|
||||
ParamsSerializerOptions,
|
||||
toFormData,
|
||||
formToJSON,
|
||||
all,
|
||||
isCancel,
|
||||
isAxiosError,
|
||||
spread
|
||||
} from 'axios';
|
||||
|
||||
const config: AxiosRequestConfig = {
|
||||
url: '/user',
|
||||
method: 'get',
|
||||
baseURL: 'https://api.example.com/',
|
||||
transformRequest: (data: any) => '{"foo":"bar"}',
|
||||
transformResponse: [
|
||||
(data: any) => ({ baz: 'qux' })
|
||||
],
|
||||
headers: { 'X-FOO': 'bar' },
|
||||
params: { id: 12345 },
|
||||
paramsSerializer: {
|
||||
indexes: true,
|
||||
encode: (value: any) => value,
|
||||
serialize: (value: Record<string, any>, options?: ParamsSerializerOptions) => String(value)
|
||||
},
|
||||
data: { foo: 'bar' },
|
||||
timeout: 10000,
|
||||
withCredentials: true,
|
||||
auth: {
|
||||
username: 'janedoe',
|
||||
password: 's00pers3cret'
|
||||
},
|
||||
responseType: 'json',
|
||||
xsrfCookieName: 'XSRF-TOKEN',
|
||||
xsrfHeaderName: 'X-XSRF-TOKEN',
|
||||
onUploadProgress: (progressEvent: AxiosProgressEvent) => {},
|
||||
onDownloadProgress: (progressEvent: AxiosProgressEvent) => {},
|
||||
maxContentLength: 2000,
|
||||
maxBodyLength: 2000,
|
||||
validateStatus: (status: number) => status >= 200 && status < 300,
|
||||
maxRedirects: 5,
|
||||
proxy: {
|
||||
host: '127.0.0.1',
|
||||
port: 9000
|
||||
},
|
||||
cancelToken: new axios.CancelToken((cancel: Canceler) => {})
|
||||
};
|
||||
|
||||
const nullValidateStatusConfig: AxiosRequestConfig = {
|
||||
validateStatus: null
|
||||
};
|
||||
|
||||
const undefinedValidateStatusConfig: AxiosRequestConfig = {
|
||||
validateStatus: undefined
|
||||
};
|
||||
|
||||
const handleResponse = (response: AxiosResponse) => {
|
||||
console.log(response.data);
|
||||
console.log(response.status);
|
||||
console.log(response.statusText);
|
||||
console.log(response.headers);
|
||||
console.log(response.config);
|
||||
};
|
||||
|
||||
const handleError = (error: AxiosError) => {
|
||||
if (error.response) {
|
||||
console.log(error.response.data);
|
||||
console.log(error.response.status);
|
||||
console.log(error.response.headers);
|
||||
} else {
|
||||
console.log(error.message);
|
||||
}
|
||||
};
|
||||
|
||||
axios(config)
|
||||
.then(handleResponse)
|
||||
.catch(handleError);
|
||||
|
||||
axios.get('/user?id=12345')
|
||||
.then(handleResponse)
|
||||
.catch(handleError);
|
||||
|
||||
axios.get('/user', { params: { id: 12345 } })
|
||||
.then(handleResponse)
|
||||
.catch(handleError);
|
||||
|
||||
axios.head('/user')
|
||||
.then(handleResponse)
|
||||
.catch(handleError);
|
||||
|
||||
axios.options('/user')
|
||||
.then(handleResponse)
|
||||
.catch(handleError);
|
||||
|
||||
axios.delete('/user')
|
||||
.then(handleResponse)
|
||||
.catch(handleError);
|
||||
|
||||
axios.post('/user', { foo: 'bar' })
|
||||
.then(handleResponse)
|
||||
.catch(handleError);
|
||||
|
||||
axios.post('/user', { foo: 'bar' }, { headers: { 'X-FOO': 'bar' } })
|
||||
.then(handleResponse)
|
||||
.catch(handleError);
|
||||
|
||||
axios.put('/user', { foo: 'bar' })
|
||||
.then(handleResponse)
|
||||
.catch(handleError);
|
||||
|
||||
axios.patch('/user', { foo: 'bar' })
|
||||
.then(handleResponse)
|
||||
.catch(handleError);
|
||||
|
||||
// Typed methods
|
||||
interface UserCreationDef {
|
||||
name: string;
|
||||
}
|
||||
|
||||
interface User {
|
||||
id: number;
|
||||
name: string;
|
||||
}
|
||||
|
||||
// with default AxiosResponse<T> result
|
||||
|
||||
const handleUserResponse = (response: AxiosResponse<User>) => {
|
||||
console.log(response.data.id);
|
||||
console.log(response.data.name);
|
||||
console.log(response.status);
|
||||
console.log(response.statusText);
|
||||
console.log(response.headers);
|
||||
console.log(response.config);
|
||||
};
|
||||
|
||||
axios.get<User>('/user?id=12345')
|
||||
.then(handleUserResponse)
|
||||
.catch(handleError);
|
||||
|
||||
axios.get<User>('/user', { params: { id: 12345 } })
|
||||
.then(handleUserResponse)
|
||||
.catch(handleError);
|
||||
|
||||
axios.head<User>('/user')
|
||||
.then(handleUserResponse)
|
||||
.catch(handleError);
|
||||
|
||||
axios.options<User>('/user')
|
||||
.then(handleUserResponse)
|
||||
.catch(handleError);
|
||||
|
||||
axios.delete<User>('/user')
|
||||
.then(handleUserResponse)
|
||||
.catch(handleError);
|
||||
|
||||
axios.post<User>('/user', { name: 'foo', id: 1 })
|
||||
.then(handleUserResponse)
|
||||
.catch(handleError);
|
||||
|
||||
axios.post<User>('/user', { name: 'foo', id: 1 }, { headers: { 'X-FOO': 'bar' } })
|
||||
.then(handleUserResponse)
|
||||
.catch(handleError);
|
||||
|
||||
axios.put<User>('/user', { name: 'foo', id: 1 })
|
||||
.then(handleUserResponse)
|
||||
.catch(handleError);
|
||||
|
||||
axios.patch<User>('/user', { name: 'foo', id: 1 })
|
||||
.then(handleUserResponse)
|
||||
.catch(handleError);
|
||||
|
||||
// (Typed methods) with custom response type
|
||||
|
||||
const handleStringResponse = (response: string) => {
|
||||
console.log(response);
|
||||
};
|
||||
|
||||
axios.get<User, string>('/user?id=12345')
|
||||
.then(handleStringResponse)
|
||||
.catch(handleError);
|
||||
|
||||
axios.get<User, string>('/user', { params: { id: 12345 } })
|
||||
.then(handleStringResponse)
|
||||
.catch(handleError);
|
||||
|
||||
axios.head<User, string>('/user')
|
||||
.then(handleStringResponse)
|
||||
.catch(handleError);
|
||||
|
||||
axios.options<User, string>('/user')
|
||||
.then(handleStringResponse)
|
||||
.catch(handleError);
|
||||
|
||||
axios.delete<User, string>('/user')
|
||||
.then(handleStringResponse)
|
||||
.catch(handleError);
|
||||
|
||||
axios.post<Partial<UserCreationDef>, string>('/user', { name: 'foo' })
|
||||
.then(handleStringResponse)
|
||||
.catch(handleError);
|
||||
|
||||
axios.post<Partial<UserCreationDef>, string>('/user', { name: 'foo' }, { headers: { 'X-FOO': 'bar' } })
|
||||
.then(handleStringResponse)
|
||||
.catch(handleError);
|
||||
|
||||
axios.put<Partial<UserCreationDef>, string>('/user', { name: 'foo' })
|
||||
.then(handleStringResponse)
|
||||
.catch(handleError);
|
||||
|
||||
axios.patch<Partial<UserCreationDef>, string>('/user', { name: 'foo' })
|
||||
.then(handleStringResponse)
|
||||
.catch(handleError);
|
||||
|
||||
axios.request<User, string>({
|
||||
method: 'get',
|
||||
url: '/user?id=12345'
|
||||
})
|
||||
.then(handleStringResponse)
|
||||
.catch(handleError);
|
||||
|
||||
// Instances
|
||||
|
||||
const instance1: AxiosInstance = axios.create();
|
||||
const instance2: AxiosInstance = axios.create(config);
|
||||
|
||||
instance1(config)
|
||||
.then(handleResponse)
|
||||
.catch(handleError);
|
||||
|
||||
instance1.request(config)
|
||||
.then(handleResponse)
|
||||
.catch(handleError);
|
||||
|
||||
instance1.get('/user?id=12345')
|
||||
.then(handleResponse)
|
||||
.catch(handleError);
|
||||
|
||||
instance1.options('/user')
|
||||
.then(handleResponse)
|
||||
.catch(handleError);
|
||||
|
||||
instance1.get('/user', { params: { id: 12345 } })
|
||||
.then(handleResponse)
|
||||
.catch(handleError);
|
||||
|
||||
instance1.post('/user', { foo: 'bar' })
|
||||
.then(handleResponse)
|
||||
.catch(handleError);
|
||||
|
||||
instance1.post('/user', { foo: 'bar' }, { headers: { 'X-FOO': 'bar' } })
|
||||
.then(handleResponse)
|
||||
.catch(handleError);
|
||||
|
||||
// Defaults
|
||||
|
||||
axios.defaults.headers['X-FOO'];
|
||||
|
||||
axios.defaults.baseURL = 'https://api.example.com/';
|
||||
axios.defaults.headers.common['Accept'] = 'application/json';
|
||||
axios.defaults.headers.post['X-FOO'] = 'bar';
|
||||
axios.defaults.timeout = 2500;
|
||||
|
||||
instance1.defaults.baseURL = 'https://api.example.com/';
|
||||
instance1.defaults.headers.common['Accept'] = 'application/json';
|
||||
instance1.defaults.headers.post['X-FOO'] = 'bar';
|
||||
instance1.defaults.timeout = 2500;
|
||||
|
||||
// axios create defaults
|
||||
|
||||
axios.create({ headers: { foo: 'bar' } });
|
||||
axios.create({ headers: { common: { foo: 'bar' } } });
|
||||
axios.create({
|
||||
headers: {
|
||||
'Content-Type': 'application/json',
|
||||
},
|
||||
formSerializer: {
|
||||
indexes: null,
|
||||
},
|
||||
paramsSerializer: {
|
||||
indexes: null,
|
||||
},
|
||||
});
|
||||
|
||||
// Interceptors
|
||||
|
||||
const requestInterceptorId: number = axios.interceptors.request.use(
|
||||
async (config: AxiosRequestConfig) => {
|
||||
await axios.get('/foo', {
|
||||
headers: config.headers
|
||||
});
|
||||
return config;
|
||||
},
|
||||
(error: any) => Promise.reject(error),
|
||||
{synchronous: false}
|
||||
);
|
||||
|
||||
axios.interceptors.request.eject(requestInterceptorId);
|
||||
|
||||
axios.interceptors.request.use(
|
||||
(config: AxiosRequestConfig) => Promise.resolve(config),
|
||||
(error: any) => Promise.reject(error)
|
||||
);
|
||||
|
||||
axios.interceptors.request.use((config: AxiosRequestConfig) => config);
|
||||
axios.interceptors.request.use((config: AxiosRequestConfig) => Promise.resolve(config));
|
||||
|
||||
const responseInterceptorId: number = axios.interceptors.response.use(
|
||||
(response: AxiosResponse) => response,
|
||||
(error: any) => Promise.reject(error)
|
||||
);
|
||||
|
||||
axios.interceptors.response.eject(responseInterceptorId);
|
||||
|
||||
axios.interceptors.response.use(
|
||||
(response: AxiosResponse) => Promise.resolve(response),
|
||||
(error: any) => Promise.reject(error)
|
||||
);
|
||||
|
||||
const voidRequestInterceptorId = axios.interceptors.request.use(
|
||||
// @ts-expect-error -- Must return an AxiosRequestConfig (or throw)
|
||||
(_response) => {},
|
||||
(error: any) => Promise.reject(error)
|
||||
);
|
||||
const voidResponseInterceptorId = axios.interceptors.response.use(
|
||||
// @ts-expect-error -- Must return an AxiosResponse (or throw)
|
||||
(_response) => {},
|
||||
(error: any) => Promise.reject(error)
|
||||
);
|
||||
axios.interceptors.request.eject(voidRequestInterceptorId);
|
||||
axios.interceptors.response.eject(voidResponseInterceptorId);
|
||||
|
||||
axios.interceptors.response.use((response: AxiosResponse) => response);
|
||||
axios.interceptors.response.use((response: AxiosResponse) => Promise.resolve(response));
|
||||
|
||||
axios.interceptors.request.clear();
|
||||
axios.interceptors.response.clear();
|
||||
|
||||
// Adapters
|
||||
|
||||
const adapter: AxiosAdapter = (config: AxiosRequestConfig) => {
|
||||
const response: AxiosResponse = {
|
||||
data: { foo: 'bar' },
|
||||
status: 200,
|
||||
statusText: 'OK',
|
||||
headers: { 'X-FOO': 'bar' },
|
||||
config
|
||||
};
|
||||
return Promise.resolve(response);
|
||||
};
|
||||
|
||||
axios.defaults.adapter = adapter;
|
||||
|
||||
// axios.all
|
||||
|
||||
const promises = [
|
||||
Promise.resolve(1),
|
||||
Promise.resolve(2)
|
||||
];
|
||||
|
||||
const promise: Promise<number[]> = axios.all(promises);
|
||||
|
||||
// axios.all named export
|
||||
|
||||
(() => {
|
||||
const promises = [
|
||||
Promise.resolve(1),
|
||||
Promise.resolve(2)
|
||||
];
|
||||
|
||||
const promise: Promise<number[]> = all(promises);
|
||||
})();
|
||||
|
||||
// axios.spread
|
||||
|
||||
const fn1 = (a: number, b: number, c: number) => `${a}-${b}-${c}`;
|
||||
const fn2: (arr: number[]) => string = axios.spread(fn1);
|
||||
|
||||
// axios.spread named export
|
||||
(() => {
|
||||
const fn1 = (a: number, b: number, c: number) => `${a}-${b}-${c}`;
|
||||
const fn2: (arr: number[]) => string = spread(fn1);
|
||||
})();
|
||||
|
||||
// Promises
|
||||
|
||||
axios.get('/user')
|
||||
.then((response: AxiosResponse) => 'foo')
|
||||
.then((value: string) => {});
|
||||
|
||||
axios.get('/user')
|
||||
.then((response: AxiosResponse) => Promise.resolve('foo'))
|
||||
.then((value: string) => {});
|
||||
|
||||
axios.get('/user')
|
||||
.then((response: AxiosResponse) => 'foo', (error: any) => 'bar')
|
||||
.then((value: string) => {});
|
||||
|
||||
axios.get('/user')
|
||||
.then((response: AxiosResponse) => 'foo', (error: any) => 123)
|
||||
.then((value: string | number) => {});
|
||||
|
||||
axios.get('/user')
|
||||
.catch((error: any) => 'foo')
|
||||
.then((value: any) => {});
|
||||
|
||||
axios.get('/user')
|
||||
.catch((error: any) => Promise.resolve('foo'))
|
||||
.then((value: any) => {});
|
||||
|
||||
// Cancellation
|
||||
|
||||
const source: CancelTokenSource = axios.CancelToken.source();
|
||||
|
||||
axios.get('/user', {
|
||||
cancelToken: source.token
|
||||
}).catch((thrown: AxiosError | Cancel) => {
|
||||
if (axios.isCancel(thrown)) {
|
||||
const cancel: Cancel = thrown;
|
||||
console.log(cancel.message);
|
||||
}
|
||||
|
||||
// named export
|
||||
if (isCancel(thrown)) {
|
||||
const cancel: Cancel = thrown;
|
||||
console.log(cancel.message);
|
||||
}
|
||||
});
|
||||
|
||||
source.cancel('Operation has been canceled.');
|
||||
|
||||
// AxiosError
|
||||
|
||||
axios.get('/user')
|
||||
.catch((error: AxiosError) => {
|
||||
if (axios.isAxiosError(error)) {
|
||||
const axiosError: AxiosError = error;
|
||||
}
|
||||
|
||||
// named export
|
||||
|
||||
if (isAxiosError(error)) {
|
||||
const axiosError: AxiosError = error;
|
||||
}
|
||||
});
|
||||
|
||||
// FormData
|
||||
|
||||
axios.toFormData({x: 1}, new FormData());
|
||||
|
||||
// named export
|
||||
toFormData({x: 1}, new FormData());
|
||||
|
||||
// formToJSON
|
||||
|
||||
axios.toFormData(new FormData());
|
||||
|
||||
// named export
|
||||
formToJSON(new FormData());
|
||||
|
||||
// AbortSignal
|
||||
|
||||
axios.get('/user', {signal: new AbortController().signal});
|
||||
|
||||
// AxiosHeaders methods
|
||||
|
||||
axios.get('/user', {
|
||||
transformRequest: [
|
||||
(data: any, headers) => {
|
||||
headers.setContentType('text/plain');
|
||||
return 'baz';
|
||||
},
|
||||
(data: any, headers) => {
|
||||
headers['foo'] = 'bar';
|
||||
return 'baz'
|
||||
}
|
||||
],
|
||||
|
||||
transformResponse: [(data: any, headers: AxiosResponseHeaders) => {
|
||||
headers.has('foo');
|
||||
}]
|
||||
});
|
||||
|
||||
// config headers
|
||||
|
||||
axios.get('/user', {
|
||||
headers: new AxiosHeaders({x:1})
|
||||
});
|
||||
|
||||
axios.get('/user', {
|
||||
headers: {
|
||||
foo : 1
|
||||
}
|
||||
});
|
||||
|
||||
// issue #5034
|
||||
|
||||
function getRequestConfig1(options: AxiosRequestConfig): AxiosRequestConfig {
|
||||
return {
|
||||
...options,
|
||||
headers: {
|
||||
...(options.headers as RawAxiosRequestHeaders),
|
||||
Authorization: `Bearer ...`,
|
||||
},
|
||||
};
|
||||
}
|
||||
|
||||
function getRequestConfig2(options: AxiosRequestConfig): AxiosRequestConfig {
|
||||
return {
|
||||
...options,
|
||||
headers: {
|
||||
...(options.headers as AxiosHeaders).toJSON(),
|
||||
Authorization: `Bearer ...`,
|
||||
},
|
||||
};
|
||||
}
|
||||
|
||||
// Max Rate
|
||||
|
||||
axios.get('/user', {
|
||||
maxRate: 1000
|
||||
});
|
||||
|
||||
axios.get('/user', {
|
||||
maxRate: [1000, 1000],
|
||||
});
|
||||
|
||||
// Node progress
|
||||
|
||||
axios.get('/user', {
|
||||
onUploadProgress: (e: AxiosProgressEvent) => {
|
||||
console.log(e.loaded);
|
||||
console.log(e.total);
|
||||
console.log(e.progress);
|
||||
console.log(e.rate);
|
||||
}
|
||||
});
|
||||
|
||||
// adapters
|
||||
|
||||
axios.get('/user', {
|
||||
adapter: 'xhr'
|
||||
});
|
||||
|
||||
axios.get('/user', {
|
||||
adapter: 'http'
|
||||
});
|
||||
|
||||
axios.get('/user', {
|
||||
adapter: ['xhr', 'http']
|
||||
});
|
||||
@@ -0,0 +1,21 @@
|
||||
{
|
||||
"name": "esm-typings-test",
|
||||
"version": "1.0.0",
|
||||
"description": "",
|
||||
"main": "index.js",
|
||||
"type": "module",
|
||||
"scripts": {
|
||||
"test:types": "tsc --noEmit",
|
||||
"test": "npm i --no-save --no-package-lock && tsc -v && npm run test:types"
|
||||
},
|
||||
"keywords": [],
|
||||
"author": "",
|
||||
"license": "MIT",
|
||||
"dependencies": {
|
||||
"@types/node": "^18.11.3",
|
||||
"axios": "file:../../../.."
|
||||
},
|
||||
"devDependencies": {
|
||||
"typescript": "^4.9.4"
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,6 @@
|
||||
{
|
||||
"compilerOptions": {
|
||||
"checkJs": true,
|
||||
"module": "node16"
|
||||
}
|
||||
}
|
||||
Reference in New Issue
Block a user