doc : headRequest

bluetianx · Oct 22, 2023 · 0769ce8 · 0769ce8
1 parent e2ea80b
commit 0769ce8
Showing 1 changed file with 39 additions and 0 deletions.
diff --git a/docs/doc_eng.md b/docs/doc_eng.md
@@ -157,6 +157,10 @@ Task<TusCreateResponse> TusCreateAsync(TusCreateRequestOption reqOption, Cancell
 | IsUploadDeferLength | bool                                                     | indicates that the size of the upload is not known currently and will be transferred later |
 | Metadata            | MetadataCollection,Implement IDictionary<string, string> | Upload-Metadata                                              |
 
+
+
+##### Returns
+
 ###### TusCreateResponse
 
 [Derived TusResponseBase](#TusResponseBase)
@@ -167,6 +171,41 @@ Task<TusCreateResponse> TusCreateAsync(TusCreateRequestOption reqOption, Cancell
 
 
 
+#### TusHeadAsync
+
+##### Definition
+
+tus Head request For getting upload-offset
+
+```c#
+Task<TusHeadResponse> TusHeadAsync(TusHeadRequestOption reqOption, CancellationToken ct = default)
+```
+
+
+
+##### Type Parameters
+
+######  TusHeadRequestOption
+
+[Derived TusRequestOptionBase](#TusRequestOptionBase)
+
+| Name         | Type | Definition      |
+| ------------ | ---- | --------------- |
+| FileLocation | Uri  | Upload File Uri |
+
+
+
+##### Returns
+
+###### TusHeadResponse
+
+[Derived TusResponseBase](#TusResponseBase)
+
+| Name         | Type | Definition             |
+| ------------ | ---- | ---------------------- |
+| UploadOffset | long | Upload Offset          |
+| UploadLength | long | the size of the upload |
+
 
 
 ---