Update API reference with information on how status changes

a179346 · Mar 3, 2024 · 9eb2662 · 9eb2662
1 parent ea9366a
commit 9eb2662
Show file tree

Hide file tree

Showing 3 changed files with 12 additions and 2 deletions.
diff --git a/.gitignore b/.gitignore
@@ -104,4 +104,6 @@ dist
 .tern-port
 
 todo
-.vscode
+.vscode
+
+excalidraw
diff --git a/assets/how-status-changes.png b/assets/how-status-changes.png
diff --git a/docs/api-reference.md b/docs/api-reference.md
@@ -39,6 +39,8 @@ status: 'pending' | 'uploading' | 'pausing' | 'paused' | 'aborted' | 'complete'
 
 The status of the uploader
 
+Reference: [How status changes](#how-status-changes)
+
 #### __bytesUploaded__ - `Accessor`
 
 ```ts
@@ -289,4 +291,10 @@ interface ChunkFormData {
 }
 ```
 
-The form data that is sent with each chunk. This includes the chunk blob, the offset, the length, and other information.
+The form data that is sent with each chunk. This includes the chunk blob, the offset, the length, and other information.
+
+# Others
+
+## How [status](#status---accessor) changes
+
+![How status changes](../assets/how-status-changes.png)