mphttpx 1.0.4 → 1.0.5

package/README.md

@@ -1,35 +1,79 @@
-# A polyfill for mini-program.
+# MPHTTPX
 
-## install
-```bash
+The `request` function of Mini Programs does not support invocation in a Promise style 
+and differs significantly from the request style in browsers. This results in the 
+need to write two different sets of code logic for the same request in Mini Programs 
+versus browsers. Therefore, the `mphttpx` library aims to make requests in Mini Programs 
+as consistent as possible with those in browsers. This project implements a subset of 
+standard browser APIs, and these implemented features are sufficient to send requests 
+using the full `XMLHttpRequest` and `fetch` in Mini Programs.
+
+## Table of Contents
+
+## Installation
+
+```
 npm install mphttpx
 ```
 
-## usage
+## Mini-Program Support
+
+| WeChat | Alipay | Baidu | ByteDance | QQ | Kwai | JD | RedNote |
+|:------:|:------:|:-----:|:---------:|:--:|:----:|:--:|:-------:|
+| Latest ✔ | Latest ✔ | Latest ✔ | Latest ✔ | Latest ✔ | Latest ✔ | Latest ✔ | Latest ✔ |
+
+## Usage
+
+### XMLHttpRequest
+
+#### Example: GET
+
+```javascript
+import { XMLHttpRequest } from "mphttpx";
+
+const xhr = new XMLHttpRequest();
+xhr.open("GET", "https://example.com/server?foo=bar&lorem=ipsum");
+
+xhr.onload = () => {
+    // Request finished. Do processing here.
+};
+
+xhr.send();
+```
+
+#### Example: POST
+
 ```javascript
-import {
-    TextEncoder,
-    TextDecoder,
-
-    Event,
-    EventTarget,
-    CustomEvent,
-    ProgressEvent,
-
-    Blob,
-    File,
-    FileReader,
-
-    FormData,
-    URLSearchParams,
-
-    AbortSignal,
-    AbortController,
-
-    XMLHttpRequest,
-    fetch,
-    Headers,
-    Request,
-    Response
-} from "mphttpx";
+import { XMLHttpRequest } from "mphttpx";
+
+const xhr = new XMLHttpRequest();
+xhr.open("POST", "https://example.com/server");
+
+// Send the proper header information along with the request
+xhr.setRequestHeader("Content-Type", "application/json;charset=UTF-8");
+
+xhr.onreadystatechange = () => {
+    // Call a function when the state changes.
+    if (xhr.readyState === XMLHttpRequest.DONE && xhr.status === 200) {
+        // Request finished. Do processing here.
+    }
+};
+
+xhr.send(JSON.stringify({ foo: "bar", lorem: "ipsum" }));
 ```
+
+#### Compatibility
+
+| Property  | Available  | Description  |
+| -------- | ---------  | -------------|
+| readyState      | ✔ | States 2: HEADERS_RECEIVED and 3: LOADING are simulated; in reality, the request has just completed at this point. |
+| response        | ✔ |
+| responseText    | ✔ |
+| responseType    | ✔ | The `"document"` is not supported, as the `Document` does not exist in mini-programs. |
+| responseURL     | ✔ | Since mini-programs cannot obtain the URL after redirection, the `responseURL` returns the URL used in the original request. |
+| responseXML     | ✖ |
+| status          | ✔ |
+| statusText      | ✔ |
+| timeout         | ✔ |
+| upload          | ✔ | The `upload` is simulated; in reality, regular requests in mini-programs cannot track the upload progress of the request body. |
+| withCredentials | ✔ | Related to Cookies, setting `withCredentials` has no effect at present; support may be added in the future. |