add doc

fix

Author: 50Bytes-dev

docs/custom-axios-config.md

@@ -0,0 +1,15 @@
+## Using a custom Axios config
+
+Sometime you may want to use your own Axios config for requests.
+`onUploadProgress` or `onDownloadProgress` are two examples of this.
+
+```typescript
+FileService.uploadFile({
+    file,
+}).axiosConfig({
+    onUploadProgress: (event) => {
+        // Do something with the event
+        console.log(event.loaded / event.total)
+    }
+})
+```

src/templates/core/CancelablePromise.hbs

@@ -26,11 +26,11 @@ export class CancelablePromise<T> implements Promise<T> {
 	#isResolved: boolean;
 	#isRejected: boolean;
 	#isCancelled: boolean;
-	#axiosConfig?: AxiosRequestConfig;
 	readonly #cancelHandlers: (() => void)[];
 	readonly #promise: Promise<T>;
 	#resolve?: (value: T | PromiseLike<T>) => void;
 	#reject?: (reason?: any) => void;
+	#axiosConfig?: AxiosRequestConfig = {};
 
 	constructor(
 		executor: (
@@ -83,7 +83,7 @@ export class CancelablePromise<T> implements Promise<T> {
 				get: (): boolean => this.#isCancelled,
 			});
 
-			const axiosConfig: AxiosRequestConfig = this.#axiosConfig || {};
+			const axiosConfig: AxiosRequestConfig = this.#axiosConfig;
 
 			return executor(onResolve, onReject, onCancel as OnCancel, axiosConfig);
 		});
@@ -130,7 +130,7 @@ export class CancelablePromise<T> implements Promise<T> {
 	}
 
 	public axiosConfig(axiosConfig: AxiosRequestConfig): this {
-		this.#axiosConfig = axiosConfig;
+		Object.assign(this.#axiosConfig as object, axiosConfig);
 		return this;
 	}
 

src/templates/core/axios/request.hbs

@@ -79,7 +79,7 @@ export const request = <T>(config: OpenAPIConfig, options: ApiRequestOptions, ax
 			const headers = await getHeaders(config, options, formData);
 
 			if (!onCancel.isCancelled) {
-				const response = await sendRequest<T>(config, options, url, body, formData, headers, onCancel, axiosClient);
+				const response = await sendRequest<T>(config, options, url, body, formData, headers, onCancel, axiosClient, axiosConfig);
 				const responseBody = getResponseBody(response);
 				const responseHeader = getResponseHeader(response, options.responseHeader);
 

src/templates/core/axios/sendRequest.hbs

@@ -7,7 +7,7 @@ export const sendRequest = async <T>(
 	headers: Record<string, string>,
 	onCancel: OnCancel,
 	axiosClient: AxiosInstance,
-	axiosConfig: AxiosRequestConfig,
+	axiosConfig?: AxiosRequestConfig,
 ): Promise<AxiosResponse<T>> => {
 	const source = axios.CancelToken.source();