Reuse DownloadProgress to Progress

sindresorhus · Sep 7, 2024 · e612cc4 · e612cc4
1 parent 7ba8edc
commit e612cc4
Show file tree

Hide file tree

Showing 3 changed files with 8 additions and 18 deletions.
diff --git a/source/core/Ky.ts b/source/core/Ky.ts
@@ -74,7 +74,7 @@ export class Ky {
 					throw new Error('Streams are not supported in your environment. `ReadableStream` is missing.');
 				}
 
-				return ky._stream(response.clone(), ky._options.onDownloadProgress);
+				return ky._streamResponse(response.clone(), ky._options.onDownloadProgress);
 			}
 
 			return response;
@@ -216,7 +216,7 @@ export class Ky {
 				this.request
 					= new globalThis.Request(this._input, {
 						...this._options,
-						body: this._wrapBodyWithUploadProgress(
+						body: this._streamRequest(
 							originalBody, totalBytes, this._options.onUploadProgress),
 					});
 			}
@@ -328,7 +328,7 @@ export class Ky {
 	}
 
 	/* istanbul ignore next */
-	protected _stream(response: Response, onDownloadProgress: Options['onDownloadProgress']) {
+	protected _streamResponse(response: Response, onDownloadProgress: Options['onDownloadProgress']) {
 		const totalBytes = Number(response.headers.get('content-length')) || 0;
 		let transferredBytes = 0;
 
@@ -430,7 +430,7 @@ export class Ky {
 		return 0; // Default case, unable to determine size
 	}
 
-	protected _wrapBodyWithUploadProgress(
+	protected _streamRequest(
 		body: BodyInit,
 		totalBytes: number,
 		onUploadProgress: (progress: {percent: number; transferredBytes: number; totalBytes: number}) => void,

diff --git a/source/index.ts b/source/index.ts
@@ -42,7 +42,7 @@ export type {
 	NormalizedOptions,
 	RetryOptions,
 	SearchParamsOption,
-	DownloadProgress,
+	Progress,
 } from './types/options.js';
 
 export type {

diff --git a/source/types/options.ts b/source/types/options.ts
@@ -12,17 +12,7 @@ export type HttpMethod = 'get' | 'post' | 'put' | 'patch' | 'head' | 'delete';
 
 export type Input = string | URL | Request;
 
-export type UploadProgress = {
-	percent: number;
-	transferredBytes: number;
-
-	/**
-	Note: If it's not possible to retrieve the body size, it will be `0`.
-	*/
-	totalBytes: number;
-};
-
-export type DownloadProgress = {
+export type Progress = {
 	percent: number;
 	transferredBytes: number;
 
@@ -196,7 +186,7 @@ export type KyOptions = {
 	});
 	```
 	*/
-	onDownloadProgress?: (progress: DownloadProgress, chunk: Uint8Array) => void;
+	onDownloadProgress?: (progress: Progress, chunk: Uint8Array) => void;
 
 	/**
 	Upload progress event handler.
@@ -215,7 +205,7 @@ export type KyOptions = {
 	});
 	```
 	*/
-	onUploadProgress?: (progress: UploadProgress) => void;
+	onUploadProgress?: (progress: Progress) => void;
 
 	/**
 	User-defined `fetch` function.