api.md

Table of Contents

• MockServer
  • init
    • Parameters
• InitOptions
  • Properties
• ResponseOptions
  • Properties
• MockRequest
  • on
    • Parameters
  • get
    • Parameters
  • post
    • Parameters
  • put
    • Parameters
  • delete
    • Parameters
  • patch
    • Parameters

MockServer

init

Init mock server and set request interception on the page

Parameters

• page Page Puppeteer's page
• options InitOptions init options

Returns Promise<MockRequest>

InitOptions

Type: Object

Properties

• baseAppUrl string Base app url. By default all requests matching base app url are continued.
• baseApiUrl string Base api url. By default all requests matching base api url are responded with 200 status and empty body, but you will see a warning in output.
• onRequest function (HTTPRequest)? Optional callback to be executed for any unhandled request. By default requests are aborted if this callback is not provided or returns falsy.
• onAppRequest function (HTTPRequest)? Optional callback to be executed for any unhandled app request, i.e. request matching baseAppUrl option. By default requests are continued if this callback is not provided or returns falsy.
• onApiRequest function (HTTPRequest)? Optional callback to be executed for any unhandled api request, i.e. request matching baseApiUrl option. By default requests are responded with 200 OK {} for convenience if this callback is not provided or returns falsy.

ResponseOptions

Type: Object

Properties

• body (function (HTTPRequest): Object | Object)? response body
• delay (Promise | number)? delay response for N milliseconds or until promise is resolved
• abort string? abort request with supplied error code
• contentType string? content type. Defaults to application/json.

MockRequest

Class for registering mock responses. It's instance is returned by mockServer.init()

on

Set expected mock response for request. There are also shortcuts .get(), .post(), .put(), .delete() and '.patch()` available

Parameters

• method string request HTTP method
• endpoint string request endpoint URL. If relative URL is passed, it's considered as a request to api relative to baseApiUrl.
• status number response status code
• options ResponseOptions? additional response options

Returns MockRequest

get

Shortcut for .on('get', ...)

Parameters

• endpoint string request endpoint URL. If relative URL is passed, it's considered as a request to api relative to baseApiUrl.
• status number response status code
• options ResponseOptions? additional response options

Returns MockRequest

post

Shortcut for .on('post', ...)

Parameters

• endpoint string request endpoint URL. If relative URL is passed, it's considered as a request to api relative to baseApiUrl.
• status number response status code
• options ResponseOptions? additional response options

Returns MockRequest

put

Shortcut for .on('put', ...)

Parameters

• endpoint string request endpoint URL. If relative URL is passed, it's considered as a request to api relative to baseApiUrl.
• status number response status code
• options ResponseOptions? additional response options

Returns MockRequest

delete

Shortcut for .on('delete', ...)

Parameters

• endpoint string request endpoint URL. If relative URL is passed, it's considered as a request to api relative to baseApiUrl.
• status number response status code
• options ResponseOptions? additional response options

Returns MockRequest

patch

Shortcut for .on('patch', ...)

Parameters

• endpoint string request endpoint URL. If relative URL is passed, it's considered as a request to api relative to baseApiUrl.
• status number response status code
• options ResponseOptions? additional response options

Returns MockRequest