http-proxy-404 - npm Package Compare versions

Comparing version 0.1.8 to 0.1.9

package.json

 {
   "name": "http-proxy-404",
-  "version": "0.1.8",
+  "version": "0.1.9",
   "description": "",
@@ -5,0 +5,0 @@ "main": "index.js",

proxy.js

@@ -16,2 +16,3 @@ const express = require('express');
       ws: options.ws || false,
+      secure: options.secure || false,
       router: function(req) {
@@ -18,0 +19,0 @@ var index = req.headers['proxy-index']

README.md

@@ -0,17 +1,29 @@
+<div align="center">
+  <h1>http-proxy-404</h1>
+  <p>just proxy serve,proxy 404 interface to target servers</p>
+</div>
 
-## 介绍
+<h2 align="center">Introduction</h2>
 
 http-proxy-404mock 是一个基于http-proxy-middleware 开发的node代理服务器
 
+<small>Http-proxy-404 is a node proxy server based on http-proxy-middleware</small>
+
 你可以用它做什么呢?
 
+<small>What can you do with it?</small>
+
 你可以配置一堆不同环境的接口服务地址
 
-它会自动嗅探接口在当前配置地址中是否404,如果404,它会往下一个地址中继续请求,直至成功
+<small>You can configure a bunch of interface service addresses for different environments.</small>
 
-## Install
+它会自动嗅探接口在当前配置的服务器地址中 请求的response的状态是否为404,如果请求的状态是404,它会往下一个地址中继续请求,直至成功
 
+<small>It will automatically sniff the interface to request the response status in the currently configured server address is 404,If the status of the request is 404, it will continue the request to the next address until it succeeds</small>
 
+<h2 align="center">Install</h2>
 
-```console
+
+
+```bash
 $ npm install http-proxy-404 --save-dev
@@ -21,11 +33,11 @@ ```
 
-```console
+```bash
 $ yarn add http-proxy-404 -D
 ```
 
-## Usage
+<h2 align="center">Usage</h2>
 
-step1: 创建serve.js
+step1: create serve.js
 
-```console
+```js
 const Proxy404 = require('http-proxy-404')
@@ -42,3 +54,5 @@
   '404func': function(res) {
-    //在这里你可以重新定义404的范围
+    if(!res.response) {
+      return true
+    }
   }
@@ -48,13 +62,10 @@ })
 
-step2: 配置webpack
+step2: Configuring webpack
 
-```console
+```js
 proxy: {
     '/': {
-      target: 这里写上http-proxy-404 起的服务地址,
+      target: "http://x.x.x.x:port", // Please fill in the proxy service address output by http-proxy-404
       ws: false,
       changeOrigin: true,
-      // bypass: function(req,res,proxyOptions) {
-      //     console.log(req.headers);
-      // }
     }
@@ -66,3 +77,3 @@ }
 
-```
+```bash
 nodemon serve.js
@@ -73,3 +84,3 @@ ```
 
-```
+```json
 "scripts": {
@@ -80,14 +91,14 @@ "dev": "webpack-dev-server xxx & nodemon serve.js"
 
-## options
+<h2 align="center">options</h2>
 
-- options.port: 代理服务的端口, 必填
-  
-- options.log: 是否打印日志 默认值true
+|Name|Required|Type|Default|Description|
+|:--:|:--:|:--:|:-----:|:----------|
+|**`port`**|**`true`**|`{Number}`| null | Proxy service port|
+|**`log`**|**`false`**|`{Boolean}`|true|Whether to print the log|
+|**`apiReg`**|**`true`**|`{String|RegExp}`|null|Interface matching rule|
+|**`changeOrigin`**|**`false`**|`{Boolean}`|true| changes the origin of the host header to the target URL|
+|**`ws`**|**`false`**|`{Boolean}`|false|if you want to proxy websockets|
+|**`404func`**|**`false`**|`{Function}`|null|Custom function used to determine 404|
+|**`secure`**|**`false`**|`{Boolean}`|false|if you want to verify the SSL Certs|
 
-- options.apiReg: 接口匹配规则
-  
-- options.changeOrigin:  将host header 改成目标 url, 默认值true
-  
-- options.ws: 如果你想代理websockets ,默认值false
 
-- options.404func: 你可以通过函数去自定 404的范围

No alert changes

Improved metrics

Total package byte prevSize

5480

increased by22.62%

Lines of code

66

increased by1.54%

Number of lines in readme file

99

increased by13.79%

No dependency changes