doc: add httx.readAsSSE() into README

.eslintrc.json

@@ -52,7 +52,7 @@
     "after": true
   },
   "parserOptions": {
-    "ecmaVersion": 8,
+    "ecmaVersion": 2023,
     "sourceType": "script",
     "ecmaFeatures": {
       "jsx": true

README.md

@@ -22,54 +22,33 @@ npm install httpx --save
 
 ## Usage
 
-```js
-'use strict';
-
-const httpx = require('httpx');
-
-httpx.request('http://www.baidu.com/').then((response) => {
-  response.pipe(process.stdout);
-
-  response.on('end', () => {
-    process.stdout.write('\n');
-  });
-}, (err) => {
-  // on error
-});
-```
-
-Or with `co`.
+### Request URL
 
 ```js
-co(function* () {
-  var response = yield httpx.request('http://www.baidu.com/');
-
-  response.pipe(process.stdout);
-
-  response.on('end', () => {
-    process.stdout.write('\n');
-  });
-});
+(async function () {
+  const response = await httpx.request('http://www.baidu.com/');
+  const body = await httpx.read(response, 'utf-8');
+  console.log(body);
+})();
 ```
 
-Or with `async/await`.
+### Request SSE URL
 
 ```js
 (async function () {
-  var response = await httpx.request('http://www.baidu.com/');
-
-  response.pipe(process.stdout);
-
-  response.on('end', () => {
-    process.stdout.write('\n');
-  });
+  const response = await httpx.request('sse url');
+  for await (const event of httpx.readAsSSE(response)) {
+    console.log(event);
+  }
 })();
 ```
 
 ## API
 
 ### `httpx.request(url[, options])`
 
+It returns `Promise<Response>`.
+
 Requests the url with options, then return the response.
 
 - **url** String | Object - The URL to request, either a String or a Object that return by [url.parse](http://nodejs.org/api/url.html#url_url_parse_urlstr_parsequerystring_slashesdenotehost).
@@ -85,11 +64,21 @@ Requests the url with options, then return the response.
 
 ### `httpx.read(response[, encoding])`
 
+It returns `Promise<Buffer | String>`.
+
 Consume the response and read all data from the response.
 
 - **response** Response - the Client response. Don't setEncoding() for the response.
 - **encoding** String - Optional. If specify the encoding, will return String. If not specify encoding, return the buffer.
 
+### `httpx.readAsSSE(response)`
+
+It returns `AsyncGenerator<Event, void, unknown>`.
+
+Consume the response data with async iterator.
+
+- **response** Response - the Client response. Don't setEncoding() for the response.
+
 ## Using with http proxy
 
 ```js

lib/index.js

@@ -270,7 +270,7 @@ function readyToRead(readable) {
       readable.removeListener('error', onError);
       readable.removeListener('end', onEnd);
       readable.removeListener('readable', onReadable);
-    }
+    };
 
     onReadable = function () {
       cleanup();
@@ -280,12 +280,12 @@ function readyToRead(readable) {
     onEnd = function () {
       cleanup();
       resolve(true);
-    }
+    };
 
     onError = function (err) {
       cleanup();
       reject(err);
-    }
+    };
 
     readable.once('readable', onReadable);
     readable.once('end', onEnd);