chore(storage): remove File type from uploadInput type (#12190)

* (chore): remove file type from input in uploadData api
aws-amplify · Oct 5, 2023 · 1d85da5 · 1d85da5
1 parent a1ea0f2
commit 1d85da5
Show file tree

Hide file tree

Showing 2 changed files with 5 additions and 5 deletions.
diff --git a/packages/storage/src/providers/s3/apis/uploadData/index.ts b/packages/storage/src/providers/s3/apis/uploadData/index.ts
@@ -26,15 +26,15 @@ import { getMultipartUploadHandlers } from './multipart';
  *
  * @example
  * ```ts
- * // Upload a file to s3 bucket
- * await uploadData({ key, data: file, options: {
+ * // Upload data to s3 bucket
+ * await uploadData({ key, data, options: {
  *   onProgress, // Optional progress callback.
  * } }).result;
  * ```
  * @example
  * ```ts
  * // Cancel a task
- * const uploadTask = uploadData({ key, data: file });
+ * const uploadTask = uploadData({ key, data });
  * //...
  * uploadTask.cancel();
  * try {
@@ -49,7 +49,7 @@ import { getMultipartUploadHandlers } from './multipart';
  * @example
  * ```ts
  * // Pause and resume a task
- * const uploadTask = uploadData({ key, data: file });
+ * const uploadTask = uploadData({ key, data });
  * //...
  * uploadTask.pause();
  * //...

diff --git a/packages/storage/src/types/inputs.ts b/packages/storage/src/types/inputs.ts
@@ -49,4 +49,4 @@ export type StorageCopyInput<
 /**
  * The data payload type for upload operation.
  */
-export type StorageUploadDataPayload = Blob | BufferSource | string | File;
+export type StorageUploadDataPayload = Blob | BufferSource | string;