From 877e9e720894e0d0916fd02bf9354fcb2ad6516e Mon Sep 17 00:00:00 2001
From: Tsanie Lily <tsorgy@gmail.com>
Date: Fri, 31 Mar 2023 08:32:04 +0800
Subject: [PATCH] complete request document.

---
 lib/utility/request.html | 74 ++++++++++++++++++++++++++++++++++++++++
 main.js                  |  4 ++-
 2 files changed, 77 insertions(+), 1 deletion(-)

diff --git a/lib/utility/request.html b/lib/utility/request.html
index 1c9539f..b3d6ab9 100644
--- a/lib/utility/request.html
+++ b/lib/utility/request.html
@@ -34,4 +34,78 @@
     <p>
         Content-Type 请求头的值
     </p>
+    <h3>customerHeaders?: { [key: string]: string }</h3>
+    <p>
+        自定义请求头，例如
+    <pre>{
+    'X-Auth-Id': 'xxxxxx',
+    'X-Auth-Token': 'xxxxxx'
+}</pre>
+    </p>
+    <h3>signal?: AbortSignal | null</h3>
+    <p>
+        终止器的信号，用来控制终止请求任务
+    </p>
+    <h3>progress?: (this: XMLHttpRequestUpload, ev: ProgressEvent&lt;XMLHttpRequestEventTarget&gt;) => any</h3>
+    <p>
+        调用 upload 方法时在上传过程中触发的事件，返回进度参数
+    </p>
+    <h3>return: Promise&lt;Response&gt;</h3>
+    <p>
+        返回一个结果为 Response 对象的 Promise
+    </p>
+    <h2>post</h2>
+    <code>function post(url: string, data?: BodyInit | null, options?: RequestOptions): Promise&lt;Response&gt;</code>
+    <h3>url: string</h3>
+    <p>
+        url 地址
+    </p>
+    <h3>data?: BodyInit | null</h3>
+    <p>
+        post 请求传递的请求正文，可以是 FormData 或者任意对象，后者会经 JSON 序列化后发送
+    </p>
+    <h3>options?: RequestOptions</h3>
+    <p>
+        请求的配置参数，结构如上述 get
+    </p>
+    <h3>return: Promise&lt;Response&gt;</h3>
+    <p>
+        返回一个结果为 Response 对象的 Promise
+    </p>
+    <h2>upload</h2>
+    <code>upload(url: string, data: FormData, options?: RequestOptions): Promise&lt;XMLHttpRequest&gt;</code>
+    <h3>url: string</h3>
+    <p>
+        url 地址
+    </p>
+    <h3>data: FormData</h3>
+    <p>
+        upload 请求传递的请求正文，仅支持 FormData
+    </p>
+    <h3>options?: RequestOptions</h3>
+    <p>
+        请求的配置参数，结构如上述 get，仅使用其中 <code>progress</code> 与 <code>customerHeaders</code>
+    </p>
+    <h3>return: Promise&lt;XMLHttpRequest&gt;</h3>
+    <p>
+        返回一个结果为 XMLHttpRequest 对象的 Promise
+    </p>
+    <hr />
+    <h2>用法</h2>
+    <pre>const request = window["lib-utility"];
+
+request.get('https://www.baidu.com')
+    .then(r => r.text())
+    .then(text => console.log(text));
+
+request.post('api/query', { id: 101 })
+    .then(r => r.json())
+    .then(result => console.log(result.data));
+
+request.upload('api/upload', data, {
+    progress: (ev) => {
+        console.log(`loaded: ${ev.loaded}, total: ${ev.total}`);
+    }
+})
+    .then(() => console.log('done.'));</pre>
 </div>
\ No newline at end of file
diff --git a/main.js b/main.js
index ed45e60..7ec72c6 100644
--- a/main.js
+++ b/main.js
@@ -19,7 +19,9 @@ function navigate(page) {
             const range = document.createRange();
             range.selectNode(document.body);
             const doc = range.createContextualFragment(html);
-            document.querySelector('#container').replaceChildren(doc);
+            const container = document.querySelector('#container');
+            container.replaceChildren(doc);
+            container.scrollTop = 0;
         });
 }