diff --git a/.gitignore b/.gitignore index 5fc10f1..9e73aaa 100644 --- a/.gitignore +++ b/.gitignore @@ -104,4 +104,6 @@ dist .tern-port todo -.vscode \ No newline at end of file +.vscode + +excalidraw \ No newline at end of file diff --git a/assets/how-status-changes.png b/assets/how-status-changes.png new file mode 100644 index 0000000..16350ba Binary files /dev/null and b/assets/how-status-changes.png differ diff --git a/docs/api-reference.md b/docs/api-reference.md index 2117310..9ba9e70 100644 --- 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. \ No newline at end of file +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) \ No newline at end of file