Improved TS support (#99)

Author: dsebastien

.gitignore

@@ -2,4 +2,3 @@ node_modules
 npm-debug.log
 yarn-error.log
 coverage
-.idea

.npmignore

@@ -1,2 +1,2 @@
 tests
-yarn.lock
+yarn.lock

README.md

@@ -48,6 +48,37 @@ Add the setupFile to your jest config in `package.json`:
 }
 ```
 
+### TypeScript guide
+
+If you are using TypeScript, then you can follow the instructions below instead.
+
+```
+$ npm install --save-dev jest-fetch-mock
+```
+
+Create a `setupJest.ts` file to setup the mock :
+
+```ts
+import {GlobalWithFetchMock} from "jest-fetch-mock";
+
+const customGlobal: GlobalWithFetchMock = global as GlobalWithFetchMock;
+customGlobal.fetch = require('jest-fetch-mock');
+customGlobal.fetchMock = customGlobal.fetch;
+```
+
+Add the setupFile to your jest config in `package.json`:
+
+```JSON
+"jest": {
+  "automock": false,
+  "setupFiles": [
+    "./setupJest.ts"
+  ]
+}
+```
+
+With this done, you'll have `fetch` and `fetchMock` available on the global scope. Fetch will be used as usual by your code and you'll use `fetchMock` in your tests.
+
 ### Using with Create-React-App
 
 If you are using [Create-React-App](https://github.com/facebookincubator/create-react-app) (CRA), the code for `setupTest.js` above should be placed into `src/setupTests.js` in the root of your project. CRA automatically uses this filename by convention in the Jest configuration it generates. Similarly, changing to your `package.json` is not required as CRA handles this when generating your Jest configuration.

package.json

@@ -3,9 +3,11 @@
   "version": "2.0.1",
   "description": "fetch mock for jest",
   "main": "src/index.js",
-  "types": "src/index.d.ts",
+  "types": "types",
   "scripts": {
-    "test": "jest"
+    "test": "jest && npm run tsc && npm run dtslint",
+    "dtslint": "dtslint types",
+    "tsc": "tsc"
   },
   "repository": {
     "type": "git",
@@ -27,11 +29,15 @@
     "promise-polyfill": "^7.1.1"
   },
   "devDependencies": {
+    "@types/jest": "^23.3.10",
+    "@types/node": "^10.12.10",
     "babel-core": "^6.26.3",
     "babel-jest": "^23.4.2",
     "babel-preset-env": "^1.7.0",
+    "dtslint": "^0.3.0",
     "jest": "^23.5.0",
-    "regenerator-runtime": "^0.12.1"
+    "regenerator-runtime": "^0.12.1",
+    "typescript": "^3.2.1"
   },
   "prettier": {
     "semi": false,

src/index.d.ts

@@ -0,0 +1,12 @@
+{
+  "extends": "./types/tsconfig.json",
+  "compilerOptions": {
+    "baseUrl": ".",
+    "rootDir": "./types",
+    "paths": {
+      "jest-fetch-mock": [
+        "./"
+      ]
+    }
+  }
+}

tsconfig.json

@@ -0,0 +1 @@
+{ "extends": "dtslint/dt.json" }

tslint.json

@@ -0,0 +1,46 @@
+// TypeScript Version: 2.3
+import Global = NodeJS.Global;
+import "jest";
+
+declare global {
+    const fetchMock: FetchMock;
+    namespace NodeJS {
+        interface Global {
+            fetch: FetchMock;
+        }
+    }
+}
+
+export interface GlobalWithFetchMock extends Global {
+    fetchMock: FetchMock;
+    fetch: FetchMock;
+}
+
+export interface FetchMock extends jest.MockInstance<any> {
+    (input?: string | Request, init?: RequestInit): Promise<Response>;
+
+    mockResponse(body: BodyOrFunction, init?: MockParams): FetchMock;
+    mockResponseOnce(body: BodyOrFunction, init?: MockParams): FetchMock;
+    once(body: BodyOrFunction, init?: MockParams): FetchMock;
+    mockResponses(...responses: Array<(BodyOrFunction | [BodyOrFunction, MockParams])>): FetchMock;
+    mockReject(error?: ErrorOrFunction): FetchMock;
+    mockRejectOnce(error?: ErrorOrFunction): FetchMock;
+    resetMocks(): void;
+}
+
+// reference: https://github.github.io/fetch/#Response
+export interface MockParams {
+    status?: number;
+    statusText?: string;
+    headers?: string[][] | { [key: string]: string }; // HeadersInit
+    url?: string;
+}
+
+export interface MockResponseInit extends MockParams {
+    body?: string;
+}
+
+export type BodyOrFunction = string | MockResponseInitFunction;
+export type ErrorOrFunction = Error | MockResponseInitFunction;
+
+export type MockResponseInitFunction = () => Promise<MockResponseInit>;

types/index.d.ts

@@ -0,0 +1,59 @@
+import { MockResponseInit } from 'jest-fetch-mock';
+
+fetchMock.mockResponse(JSON.stringify({foo: "bar"}));
+fetchMock.mockResponse(JSON.stringify({foo: "bar"}), {
+    status: 200,
+    headers: [
+        ["Content-Type", "application/json"]
+    ]
+});
+fetchMock.mockResponse(JSON.stringify({foo: "bar"}), {});
+fetchMock.mockResponse(someAsyncHandler);
+fetchMock.mockResponse(someAsyncHandler, {});
+
+fetchMock.mockResponseOnce(JSON.stringify({foo: "bar"}));
+fetchMock.mockResponseOnce(JSON.stringify({foo: "bar"}), {
+    status: 200,
+    headers: [
+        ["Content-Type", "application/json"]
+    ]
+});
+fetchMock.mockResponseOnce(JSON.stringify({foo: "bar"}), {});
+fetchMock.mockResponseOnce(someAsyncHandler);
+fetchMock.mockResponseOnce(someAsyncHandler, {});
+
+fetchMock.once(JSON.stringify({foo: "bar"}));
+fetchMock.once(JSON.stringify({foo: "bar"}), {
+    status: 200,
+    headers: [
+        ["Content-Type", "application/json"]
+    ]
+});
+fetchMock.once(JSON.stringify({foo: "bar"}), {});
+fetchMock.once(someAsyncHandler);
+fetchMock.once(someAsyncHandler, {});
+
+fetchMock.mockResponses(JSON.stringify({}), JSON.stringify({foo: "bar"}));
+fetchMock.mockResponses(someAsyncHandler, someAsyncHandler);
+fetchMock.mockResponses(JSON.stringify({}), someAsyncHandler);
+fetchMock.mockResponses(someAsyncHandler, JSON.stringify({}));
+fetchMock.mockResponses([someAsyncHandler, {status: 200}]);
+fetchMock.mockResponses([JSON.stringify({foo: "bar"}), {status: 200}]);
+fetchMock.mockResponses(
+    [someAsyncHandler, {status: 200}],
+    [JSON.stringify({foo: "bar"}), {status: 200}]
+);
+
+fetchMock.mockReject(new Error("oops"));
+fetchMock.mockReject(someAsyncHandler);
+
+fetchMock.mockRejectOnce(new Error("oops"));
+fetchMock.mockRejectOnce(someAsyncHandler);
+fetchMock.resetMocks();
+
+async function someAsyncHandler(): Promise<MockResponseInit> {
+    return {
+        status: 200,
+        body: JSON.stringify({foo: "bar"})
+    };
+}

types/test.ts

@@ -0,0 +1,21 @@
+{
+  "compilerOptions": {
+    "module": "commonjs",
+    "lib": [
+      "es2015",
+      "dom"
+    ],
+    "baseUrl": ".",
+    "paths": {
+      "jest-fetch-mock": [
+        "."
+      ]
+    },
+    "noImplicitAny": true,
+    "noImplicitThis": true,
+    "strictNullChecks": true,
+    "strictFunctionTypes": true,
+    "noEmit": true,
+    "forceConsistentCasingInFileNames": true
+  }
+}