Skip to content

Commit de91424

Browse files
committed
readme
1 parent fc075fb commit de91424

File tree

2 files changed

+52
-1
lines changed

2 files changed

+52
-1
lines changed

README.md

+42
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
# DevMock
2+
3+
Webpack Dev Server mocking engine
4+
5+
## Install
6+
7+
```sh
8+
npm i --save devmock
9+
```
10+
11+
or
12+
13+
```sh
14+
yarn add devmock
15+
```
16+
17+
And require it for further usage
18+
```js
19+
const { DevMock } = require("devmock")
20+
```
21+
22+
## Usage
23+
24+
### For `webpack-dev-server` < `4.0`
25+
26+
```js
27+
devServer: {
28+
before: DevMock.v3({
29+
mocksPath: path.resolve("mocks/**/*.mock.js")
30+
})
31+
}
32+
```
33+
34+
### For `webpack-dev-server` >= `4.0`
35+
36+
```js
37+
devServer: {
38+
onBeforeSetupMiddleware: DevMock.make({
39+
mocksPath: path.resolve("mocks/**/*.mock.js")
40+
})
41+
}
42+
```

lib/DevMock.js

+10-1
Original file line numberDiff line numberDiff line change
@@ -9,12 +9,21 @@ class DevMock {
99
return new DevMock(...args).middleware
1010
}
1111

12+
static v3(...args) {
13+
return new DevMock(...args).v3Middleware
14+
}
15+
1216
constructor({ mocksPath }) {
1317
this.files = glob.sync(mocksPath)
1418
}
1519

16-
middleware = ({ app, options, logger }) => {
20+
middleware = (...args) => this.v4middleware(...args)
21+
22+
v3Middleware = (app, { headers }) => this.v4middleware({ app, options: { headers }})
23+
24+
v4middleware = ({ app, options }) => {
1725
const { headers } = options
26+
const logger = console
1827

1928
app.use(express.json())
2029

0 commit comments

Comments
 (0)