feat: nodejs support doc and in tests using cross-fetch

Author: joelgallant

README.md

@@ -4,7 +4,6 @@ Tiny wrapper around DOM fetch for common API wrappings.
 [![](https://shields.servallapps.com/npm/v/@lcdev/fetch.svg?registry_uri=https%3A%2F%2Fnpm.servalldatasystems.com)](https://npm.servalldatasystems.com/#/detail/@lcdev/fetch)
 
 ```bash
-# replace VERSION below with the most recent major version above (eg. 0.5.1 -> 0.5, 1.2.3 -> 1)
 yarn add @lcdev/fetch@VERSION
 ```
 
@@ -13,6 +12,9 @@ Use:
 ```typescript
 import { HttpMethod, api, apiCall } from '@lcdev/fetch';
 
+// one-off requests are easy
+await apiCall('https://base-url.com/endpoint').json<MyReturnType>();
+
 // re-use this any time you want to make a call to this api
 const myCoreApi = api('https://base-url.com');
 
@@ -23,9 +25,6 @@ await myCoreApi.get('/endpoint')
   .withQuery({ baz: 'bat' })
   // chain .json if you know the response is json
   .json<MyReturnType>();
-
-// don't need to define a base URL up front for one-offs
-await apiCall('https://base-url.com/endpoint').json<MyReturnType>();
 ```
 
 Requests start on await/then. Chain to add data to the request. This is just a thin way to make `fetch` calls.
@@ -63,3 +62,10 @@ Chainable methods for API calls:
 
 A base API itself can be called with `.get`, `.post`, etc. You can change the base URL if required
 with `changeBaseURL(path)`, though be warned that every request from then on will then be based on that.
+
+## NodeJS Support
+Just polyfill `fetch`, and this package will work. Install `cross-fetch` package and add the following to your main file.
+
+```typescript
+import 'cross-fetch/polyfill';
+```

package.json

@@ -32,11 +32,10 @@
     "@lcdev/tsconfig": "0.1",
     "@types/jest": "24",
     "@types/koa": "2",
-    "@types/node-fetch": "2",
+    "cross-fetch": "3",
     "eslint": "6",
     "husky": "3",
     "jest": "24",
-    "node-fetch": "2",
     "prettier": "1",
     "typescript": "3"
   },

src/index.test.ts

@@ -1,13 +1,7 @@
 import * as http from 'http';
-import fetch, { Headers, Request, Response } from 'node-fetch';
 import { HttpMethod, buildPath, api, apiCall } from './index';
 
-Object.assign(global, {
-  fetch,
-  Headers,
-  Request,
-  Response,
-});
+import 'cross-fetch/polyfill';
 
 describe('buildings paths', () => {
   test('basic additions', () => {

yarn.lock

@@ -639,13 +639,6 @@
   resolved "https://registry.yarnpkg.com/@types/mime/-/mime-2.0.1.tgz#dc488842312a7f075149312905b5e3c0b054c79d"
   integrity sha512-FwI9gX75FgVBJ7ywgnq/P7tw+/o1GUbtP0KzbtusLigAOgIgNISRK0ZPl4qertvXSIE8YbsVJueQ90cDt9YYyw==
 
-"@types/node-fetch@2":
-  version "2.5.4"
-  resolved "https://registry.yarnpkg.com/@types/node-fetch/-/node-fetch-2.5.4.tgz#5245b6d8841fc3a6208b82291119bc11c4e0ce44"
-  integrity sha512-Oz6id++2qAOFuOlE1j0ouk1dzl3mmI1+qINPNBhi9nt/gVOz0G+13Ao6qjhdF0Ys+eOkhu6JnFmt38bR3H0POQ==
-  dependencies:
-    "@types/node" "*"
-
 "@types/node@*", "@types/node@^12.0.2":
   version "12.12.21"
   resolved "https://registry.yarnpkg.com/@types/node/-/node-12.12.21.tgz#aa44a6363291c7037111c47e4661ad210aded23f"
@@ -1360,6 +1353,13 @@ cosmiconfig@^5.2.0, cosmiconfig@^5.2.1:
     js-yaml "^3.13.1"
     parse-json "^4.0.0"
 
+cross-fetch@3:
+  version "3.0.5"
+  resolved "https://registry.yarnpkg.com/cross-fetch/-/cross-fetch-3.0.5.tgz#2739d2981892e7ab488a7ad03b92df2816e03f4c"
+  integrity sha512-FFLcLtraisj5eteosnX1gf01qYDCOc4fDy0+euOt8Kn9YBY2NtXL/pCoYPavw24NIQkQqm5ZOLsGD5Zzj0gyew==
+  dependencies:
+    node-fetch "2.6.0"
+
 cross-spawn@^6.0.0, cross-spawn@^6.0.5:
   version "6.0.5"
   resolved "https://registry.yarnpkg.com/cross-spawn/-/cross-spawn-6.0.5.tgz#4a5ec7c64dfae22c3a14124dbacdee846d80cbc4"
@@ -3451,7 +3451,7 @@ nice-try@^1.0.4:
   resolved "https://registry.yarnpkg.com/nice-try/-/nice-try-1.0.5.tgz#a3378a7696ce7d223e88fc9b764bd7ef1089e366"
   integrity sha512-1nh45deeb5olNY7eX82BkPO7SSxR5SSYJiPTrTdFUVYwAl8CKMA5N9PjTYkHiRjisVcxcQ1HXdLhx2qxxJzLNQ==
 
-node-fetch@2:
+node-fetch@2.6.0:
   version "2.6.0"
   resolved "https://registry.yarnpkg.com/node-fetch/-/node-fetch-2.6.0.tgz#e633456386d4aa55863f676a7ab0daa8fdecb0fd"
   integrity sha512-8dG4H5ujfvFiqDmVu9fQ5bOHUC15JMjMY/Zumv26oOvvVJjM67KF8koCWIabKQ1GJIa9r2mMZscBq/TbdOcmNA==