mock-inspect
Advanced tools
Comparing version
@@ -10,6 +10,18 @@ # Changelog | ||
## [v4.0.2](https://github.com/trayio/mock-inspect/compare/v4.0.1...v4.0.2) | ||
## [v5.0.0](https://github.com/trayio/mock-inspect/compare/v4.0.2...v5.0.0) | ||
### Merged | ||
- Bump browserslist from 4.16.4 to 4.16.6 [`#67`](https://github.com/trayio/mock-inspect/pull/67) | ||
- 4.0.2 [`#70`](https://github.com/trayio/mock-inspect/pull/70) | ||
### Commits | ||
- Remove mockRequestFromExample [`78b3c29`](https://github.com/trayio/mock-inspect/commit/78b3c29d240bee156731b1f9d5ee9dd99cd0ddae) | ||
- revert version number [`c60d4b1`](https://github.com/trayio/mock-inspect/commit/c60d4b11e0a90a145d559885129029b3d3a0420b) | ||
## [v4.0.2](https://github.com/trayio/mock-inspect/compare/v4.0.1...v4.0.2) - 2021-05-27 | ||
### Merged | ||
- [Issue 68] Don't lowercase request headers returne by inspect [`#69`](https://github.com/trayio/mock-inspect/pull/69) | ||
@@ -16,0 +28,0 @@ - Update CODEOWNERS [`#65`](https://github.com/trayio/mock-inspect/pull/65) |
import { MockedRequest } from "./MockedRequest"; | ||
import { MockResponseOptions } from "./types/MockResponseOptions"; | ||
import { Example } from "./types/Example"; | ||
export { Example } from "./types/Example"; | ||
export { MockedRequest } from "./MockedRequest"; | ||
export declare const mockRequest: (mockOpts: MockResponseOptions) => MockedRequest; | ||
export declare const mockRequestFromExample: (example: Example) => MockedRequest; | ||
export { cleanUpNetworkRequestMocking, setUpNetworkRequestMocking, tearDownNetworkRequestMocking, } from "./setupAndTeardown"; | ||
export { MockResponseOptions } from "./types/MockResponseOptions"; |
"use strict"; | ||
Object.defineProperty(exports, "__esModule", { value: true }); | ||
exports.tearDownNetworkRequestMocking = exports.setUpNetworkRequestMocking = exports.cleanUpNetworkRequestMocking = exports.mockRequestFromExample = exports.mockRequest = exports.MockedRequest = void 0; | ||
exports.tearDownNetworkRequestMocking = exports.setUpNetworkRequestMocking = exports.cleanUpNetworkRequestMocking = exports.mockRequest = exports.MockedRequest = void 0; | ||
var MockedRequest_1 = require("./MockedRequest"); | ||
@@ -13,16 +13,2 @@ Object.defineProperty(exports, "MockedRequest", { enumerable: true, get: function () { return MockedRequest_1.MockedRequest; } }); | ||
exports.mockRequest = mockRequest; | ||
var mockRequestFromExample = function (example) { | ||
var stacktrace = utils_1.generateStacktraceWithoutMockedRequestInfo(); | ||
return mockRequest_1.mockRequestBase({ | ||
mockOpts: { | ||
requestPattern: example.request.url, | ||
responseStatus: example.response.statusCode, | ||
responseBody: example.response.body, | ||
requestMethod: example.request.method, | ||
responseHeaders: example.response.headers, | ||
}, | ||
stacktrace: stacktrace, | ||
}); | ||
}; | ||
exports.mockRequestFromExample = mockRequestFromExample; | ||
var setupAndTeardown_1 = require("./setupAndTeardown"); | ||
@@ -29,0 +15,0 @@ Object.defineProperty(exports, "cleanUpNetworkRequestMocking", { enumerable: true, get: function () { return setupAndTeardown_1.cleanUpNetworkRequestMocking; } }); |
{ | ||
"name": "mock-inspect", | ||
"version": "4.0.2", | ||
"version": "5.0.0", | ||
"description": "", | ||
@@ -5,0 +5,0 @@ "main": "dist/index.js", |
@@ -164,31 +164,2 @@  | ||
## mockRequestFromExample | ||
Mocks a request based on an example and returns a [MockedRequest](#mockedrequest) object. An example is an object which holds all the details of a network request - how it is supposed to be made and what it is supposed to return. [Check out the type definition](https://github.com/trayio/mock-inspect/blob/main/src/types/Example.ts) for details of properties you can enter. | ||
```js | ||
const {mockRequestFromExample} = require("mock-inspect") | ||
const loginExample = { | ||
response: { | ||
statusCode: 201, | ||
body: "Welcome!", | ||
headers: { | ||
"Authorization": "take your token good sir!" | ||
} | ||
}, | ||
request: { | ||
url: "https://www.yourwebsite.com/login", | ||
method: "POST", | ||
payload: { | ||
"username": "HanSolo", | ||
"password": "Never tell me the odds!" | ||
} | ||
} | ||
} | ||
const loginRequest = mockRequestFromExample(loginExample) | ||
// ... make a network request somewhere in your actual code ... | ||
loginRequest.expectRequestToHaveBeenMade() | ||
``` | ||
## MockedRequest | ||
@@ -195,0 +166,0 @@ |
68707
-2.61%41
-4.65%773
-4.8%299
-8.84%