kewl

Author: juliusmarminge

packages/uploadthing/src/client-future.ts

@@ -45,7 +45,7 @@ export type UploadThingClientError<TErrorShape> =
 /**
  * A file that has not started uploading yet.
  * Can either be pending for the presigned request to resolve,
- * or pending for the browser to upload the file to the storage provider.
+ * or pending for the browser to schedule the network request.
  */
 export interface PendingFile extends File {
   status: "pending";
@@ -134,6 +134,7 @@ export type AnyFile<TFileRoute extends AnyFileRoute> =
 
 /**
  * Predicate function to check if a file is pending
+ * @public
  */
 export function isPendingFile<TRoute extends AnyFileRoute = AnyFileRoute>(
   file: AnyFile<TRoute>,
@@ -143,6 +144,7 @@ export function isPendingFile<TRoute extends AnyFileRoute = AnyFileRoute>(
 
 /**
  * Predicate function to check if a file is uploading
+ * @public
  */
 export function isUploadingFile<TRoute extends AnyFileRoute = AnyFileRoute>(
   file: AnyFile<TRoute>,
@@ -152,6 +154,7 @@ export function isUploadingFile<TRoute extends AnyFileRoute = AnyFileRoute>(
 
 /**
  * Predicate function to check if a file is failed
+ * @public
  */
 export function isFailedFile<TRoute extends AnyFileRoute = AnyFileRoute>(
   file: AnyFile<TRoute>,
@@ -161,6 +164,7 @@ export function isFailedFile<TRoute extends AnyFileRoute = AnyFileRoute>(
 
 /**
  * Predicate function to check if a file is uploaded
+ * @public
  */
 export function isUploadedFile<TRoute extends AnyFileRoute = AnyFileRoute>(
   file: AnyFile<TRoute>,
@@ -170,6 +174,7 @@ export function isUploadedFile<TRoute extends AnyFileRoute = AnyFileRoute>(
 
 /**
  * Modifies a pending file to an uploading file in place
+ * @internal
  */
 function transitionToUploading(
   file: PendingFile,
@@ -183,6 +188,7 @@ function transitionToUploading(
 
 /**
  * Modifies an uploading file to an uploaded file in place
+ * @internal
  */
 function transitionToUploaded<TRoute extends AnyFileRoute>(
   file: UploadingFile,
@@ -198,6 +204,7 @@ function transitionToUploaded<TRoute extends AnyFileRoute>(
 
 /**
  * Modifies a pending or uploading file to a failed file in place
+ * @internal
  */
 function transitionToFailed<TRoute extends AnyFileRoute>(
   file: PendingFile | UploadingFile,
@@ -209,6 +216,10 @@ function transitionToFailed<TRoute extends AnyFileRoute>(
   return failedFile;
 }
 
+/**
+ * Event emitted when the presigned URLs have been retrieved from your server
+ * @public
+ */
 export interface PresignedReceivedEvent<TRoute extends AnyFileRoute> {
   type: "presigned-received";
   /**
@@ -217,6 +228,10 @@ export interface PresignedReceivedEvent<TRoute extends AnyFileRoute> {
   files: AnyFile<TRoute>[];
 }
 
+/**
+ * Event emitted when a file starts uploading
+ * @public
+ */
 export interface UploadStartedEvent<TRoute extends AnyFileRoute> {
   type: "upload-started";
   /**
@@ -229,10 +244,14 @@ export interface UploadStartedEvent<TRoute extends AnyFileRoute> {
   files: AnyFile<TRoute>[];
 }
 
+/**
+ * Event emitted when a file is uploading and received a progress update
+ * @public
+ */
 export interface UploadProgressEvent<TRoute extends AnyFileRoute> {
   type: "upload-progress";
   /**
-   * The file that is currently uploading.
+   * The file that is currently uploading and received a progress update.
    */
   file: UploadingFile;
   /**
@@ -241,6 +260,10 @@ export interface UploadProgressEvent<TRoute extends AnyFileRoute> {
   files: AnyFile<TRoute>[];
 }
 
+/**
+ * Event emitted when a file has finished uploading
+ * @public
+ */
 export interface UploadCompletedEvent<TRoute extends AnyFileRoute> {
   type: "upload-completed";
   /**
@@ -253,6 +276,10 @@ export interface UploadCompletedEvent<TRoute extends AnyFileRoute> {
   files: AnyFile<TRoute>[];
 }
 
+/**
+ * Event emitted when a file failed to upload
+ * @public
+ */
 export interface UploadFailedEvent<TRoute extends AnyFileRoute> {
   type: "upload-failed";
   /**
@@ -265,6 +292,10 @@ export interface UploadFailedEvent<TRoute extends AnyFileRoute> {
   files: AnyFile<TRoute>[];
 }
 
+/**
+ * Event emitted throughout the upload process
+ * @public
+ */
 export type UploadEvent<TRoute extends AnyFileRoute> =
   | PresignedReceivedEvent<TRoute>
   | UploadStartedEvent<TRoute>