network matcher doc

[mgrybyk]

• moved API to another doc
• added ## Network Matchers section (please review!)

#185

[codecov]

Codecov Report

Merging #201 into master will increase coverage by 0.97%.
The diff coverage is n/a.

@@            Coverage Diff             @@
##           master     #201      +/-   ##
==========================================
+ Coverage   74.64%   75.62%   +0.97%     
==========================================
  Files          40       40              
  Lines         852      886      +34     
  Branches      205      221      +16     
==========================================
+ Hits          636      670      +34     
  Misses        203      203              
  Partials       13       13              

Impacted Files	Coverage Δ
src/matchers/mock/toBeRequestedWith.ts	98.10% <0.00%> (+0.52%)	⬆️

---

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update a769358...6409552. Read the comment docs.

[christian-bromann]

Given the following example:

expect(mock).toBeRequestedWith({
    url: 'http://localhost:8080/api/todo',          // [optional] string | function | custom matcher
    method: 'POST',                                 // [optional] string | array
    requestHeaders: { Authorization: 'foo' },       // [optional] object | function | custom matcher
    responseHeaders: { Authorization: 'bar' },      // [optional] object | function | custom matcher
    request: { title: 'foo', description: 'bar' },  // [optional] object | function | custom matcher
    response: { success: true },                    // [optional] object | function | custom matcher
})

What is the request property suppose to represent here? The request payload or its params? Maybe it is more clear if it is called requestPayload.

We can do a separate PR for it. These docs changes look good 👍

[mgrybyk]

It represents the request payload.
I can rename it to what you've suggested or to postData according to the puppeteer docs https://github.com/puppeteer/puppeteer/blob/main/docs/api.md#httprequestpostdata

[christian-bromann]

@mgrybyk postData sounds good to me.

[mgrybyk]

#208

[mgrybyk]

@christian-bromann merged this one because webdriverio/webdriverio#5818 is merged