fitch - npm Package Compare versions

Comparing version 0.1.1 to 0.1.2

.eslintrc

@@ -9,5 +9,4 @@ {
     "linebreak-style": 0,
-    "semi": 0,
     "no-console": 0
   }
 }

package.json

 {
   "name": "fitch",
-  "version": "0.1.1",
+  "version": "0.1.2",
   "description": "Test using fetch API",
@@ -5,0 +5,0 @@ "main": "src/index.js",

README.md

@@ -5,8 +5,86 @@ ![Fitch.js](https://github.com/raphaelpor/fitch.js/raw/master/assets/fitch-mini.png)
 
-## Run local
+## Get started
+### Install
 ```sh
-git clone https://github.com/raphaelpor/fitch.js && cd fitch.js
-npm i
+npm i --save fitch
+```
+
+## Use
+
+** With ES2015 or TypeScript:**
+
+```js
+import fitch from 'fitch'
+```
+
+**CommonJS:**
+
+```js
+const fitch = require('fitch')
+```
+
+**UMD:**
+
+```html
+<script src="node_modules/fitch/src/index.js"></script>
+```
+
+### Make your first request:
+```js
+fitch.get(apiUrl)
+  .then(data => console.log(data))
+```
+
+## Methods available:
+### get
+```js
+fitch.get(apiUrl)
+  .then(data => console.log(data))
+```
+
+### post
+```js
+const req = {body: {name: 'Happy cat'}}
+
+fitch.get(apiUrl, req)
+  .then(data => console.log(data))
+```
+
+### put
+```js
+const req = {body: {name: 'Happy cat'}}
+
+fitch.get(apiUrl, req)
+  .then(data => console.log(data))
+```
+
+### patch
+```js
+const req = {body: {name: 'Happy cat'}}
+
+fitch.get(apiUrl, req)
+  .then(data => console.log(data))
+```
+
+### delete
+```js
+fitch.get(apiUrl)
+  .then(data => console.log(data))
+```
+
+## Use with custom configuration
+```js
+fitch.get(apiUrl, config)
+  .then(data => console.log(data))
+```
+
+## Contributig
+First yout need to fork this repository. Then:
+```sh
+npm i # install local dependencies
 npm start # run local server
+npm run watch:test # watch files inside src/ and tests/
 npm run examples # run examples
 ```
+It is important that the code can be tested and pass in linter check.
+You can verify your code with ESLint, using `npm run lint`.

src/config.js

@@ -17,4 +17,4 @@ module.exports = {
       mode,
-    }
+    };
   },
-}
+};

src/index.js

 // Verify if is running in browser
 const nodeFetch = require('node-fetch');
 
-const f = typeof window === 'undefined' ? nodeFetch : fetch
+const f = typeof window === 'undefined' ? nodeFetch : fetch;
 
@@ -10,24 +10,24 @@ const config = require('./config');
   get(url, req) {
-    return this.request('GET', url, req)
+    return this.request('GET', url, req);
   },
 
   post(url, req) {
-    return this.request('POST', url, req)
+    return this.request('POST', url, req);
   },
 
   put(url, req) {
-    return this.request('PUT', url, req)
+    return this.request('PUT', url, req);
   },
 
   patch(url, req) {
-    return this.request('PATCH', url, req)
+    return this.request('PATCH', url, req);
   },
 
   delete(url, req) {
-    return this.request('DELETE', url, req)
+    return this.request('DELETE', url, req);
   },
 
   request(method, url, req) {
-    const params = config.create(method, req)
-    return f(url, params).then(this.check)
+    const params = config.create(method, req);
+    return f(url, params).then(this.check);
   },
@@ -37,5 +37,5 @@
     if (resp.ok) {
-      return resp.json()
+      return resp.json();
     }
-    throw new Error(`${resp.status} - ${resp.statusText}.`)
+    throw new Error(`${resp.status} - ${resp.statusText}.`);
   },
@@ -46,2 +46,2 @@
   },
-}
+};

.nyc_output/22b430a11f724e0e531f8b448fb284b6.json

-{"C:\\Users\\raphael.freitas\\Documents\\GitHub\\fitch.js\\tests\\test.config.js":{"path":"C:\\Users\\raphael.freitas\\Documents\\GitHub\\fitch.js\\tests\\test.config.js","statementMap":{"0":{"start":{"line":1,"column":0},"end":{"line":null,"column":-1}},"1":{"start":{"line":2,"column":0},"end":{"line":null,"column":-1}},"2":{"start":{"line":4,"column":0},"end":{"line":null,"column":-1}},"3":{"start":{"line":4,"column":23},"end":{"line":null,"column":-1}},"4":{"start":{"line":8,"column":0},"end":{"line":null,"column":-1}},"5":{"start":{"line":8,"column":23},"end":{"line":null,"column":-1}}},"fnMap":{"0":{"name":"(anonymous_5)","decl":{"start":{"line":4,"column":23},"end":{"line":null,"column":-1}},"loc":{"start":{"line":4,"column":23},"end":{"line":4,"column":0}}},"1":{"name":"(anonymous_6)","decl":{"start":{"line":8,"column":23},"end":{"line":null,"column":-1}},"loc":{"start":{"line":8,"column":23},"end":{"line":8,"column":0}}}},"branchMap":{"0":{"loc":{"start":{"line":5,"column":2},"end":{"line":null,"column":-1}},"type":"cond-expr","locations":[{"start":{"line":5,"column":2},"end":{"line":null,"column":-1}},{"start":{"line":5,"column":2},"end":{"line":null,"column":-1}}]},"1":{"loc":{"start":{"line":9,"column":2},"end":{"line":null,"column":-1}},"type":"cond-expr","locations":[{"start":{"line":9,"column":2},"end":{"line":null,"column":-1}},{"start":{"line":9,"column":2},"end":{"line":null,"column":-1}}]}},"s":{"0":1,"1":1,"2":1,"3":2,"4":1,"5":2},"f":{"0":1,"1":1},"b":{"0":[0,1],"1":[0,1]}},"C:\\Users\\raphael.freitas\\Documents\\GitHub\\fitch.js\\src\\config.js":{"path":"C:\\Users\\raphael.freitas\\Documents\\GitHub\\fitch.js\\src\\config.js","statementMap":{"0":{"start":{"line":1,"column":0},"end":{"line":19,"column":1}},"1":{"start":{"line":11,"column":4},"end":{"line":17,"column":5}}},"fnMap":{},"branchMap":{"0":{"loc":{"start":{"line":4,"column":4},"end":{"line":9,"column":10}},"type":"default-arg","locations":[{"start":{"line":9,"column":8},"end":{"line":9,"column":10}}]},"1":{"loc":{"start":{"line":5,"column":6},"end":{"line":5,"column":15}},"type":"default-arg","locations":[{"start":{"line":5,"column":13},"end":{"line":5,"column":15}}]},"2":{"loc":{"start":{"line":6,"column":6},"end":{"line":6,"column":23}},"type":"default-arg","locations":[{"start":{"line":6,"column":14},"end":{"line":6,"column":23}}]},"3":{"loc":{"start":{"line":7,"column":6},"end":{"line":7,"column":54}},"type":"default-arg","locations":[{"start":{"line":7,"column":16},"end":{"line":7,"column":54}}]},"4":{"loc":{"start":{"line":8,"column":6},"end":{"line":8,"column":19}},"type":"default-arg","locations":[{"start":{"line":8,"column":13},"end":{"line":8,"column":19}}]}},"s":{"0":1,"1":0},"f":{},"b":{"0":[0],"1":[0],"2":[0],"3":[0],"4":[0]},"hash":"898c33fbdaa78bbaf1b6d1d0f7f2e8c8c5e16fdf"}}

.nyc_output/7b316419700f30c7b4e55872dcf1aec4.json

-{}

.nyc_output/f187133f5e0b2cf392eb8cb0294d8c9e.json

-{"C:\\Users\\raphael.freitas\\Documents\\GitHub\\fitch.js\\tests\\test.index.js":{"path":"C:\\Users\\raphael.freitas\\Documents\\GitHub\\fitch.js\\tests\\test.index.js","statementMap":{"0":{"start":{"line":1,"column":0},"end":{"line":null,"column":-1}},"1":{"start":{"line":2,"column":0},"end":{"line":null,"column":-1}},"2":{"start":{"line":4,"column":16},"end":{"line":4,"column":0}},"3":{"start":{"line":6,"column":18},"end":{"line":6,"column":0}},"4":{"start":{"line":10,"column":16},"end":{"line":10,"column":0}},"5":{"start":{"line":14,"column":0},"end":{"line":null,"column":-1}},"6":{"start":{"line":14,"column":20},"end":{"line":null,"column":-1}},"7":{"start":{"line":15,"column":26},"end":{"line":null,"column":-1}},"8":{"start":{"line":18,"column":0},"end":{"line":null,"column":-1}},"9":{"start":{"line":18,"column":21},"end":{"line":null,"column":-1}},"10":{"start":{"line":19,"column":46},"end":{"line":null,"column":-1}},"11":{"start":{"line":22,"column":0},"end":{"line":null,"column":-1}},"12":{"start":{"line":22,"column":20},"end":{"line":null,"column":-1}},"13":{"start":{"line":23,"column":44},"end":{"line":null,"column":-1}},"14":{"start":{"line":26,"column":0},"end":{"line":null,"column":-1}},"15":{"start":{"line":26,"column":22},"end":{"line":null,"column":-1}},"16":{"start":{"line":27,"column":46},"end":{"line":null,"column":-1}},"17":{"start":{"line":30,"column":0},"end":{"line":null,"column":-1}},"18":{"start":{"line":30,"column":23},"end":{"line":null,"column":-1}},"19":{"start":{"line":31,"column":36},"end":{"line":null,"column":-1}}},"fnMap":{"0":{"name":"(anonymous_1)","decl":{"start":{"line":14,"column":20},"end":{"line":null,"column":-1}},"loc":{"start":{"line":14,"column":20},"end":{"line":14,"column":0}}},"1":{"name":"(anonymous_2)","decl":{"start":{"line":15,"column":26},"end":{"line":null,"column":-1}},"loc":{"start":{"line":15,"column":26},"end":{"line":15,"column":2}}},"2":{"name":"(anonymous_3)","decl":{"start":{"line":18,"column":21},"end":{"line":null,"column":-1}},"loc":{"start":{"line":18,"column":21},"end":{"line":18,"column":0}}},"3":{"name":"(anonymous_4)","decl":{"start":{"line":19,"column":46},"end":{"line":null,"column":-1}},"loc":{"start":{"line":19,"column":46},"end":{"line":19,"column":2}}},"4":{"name":"(anonymous_5)","decl":{"start":{"line":22,"column":20},"end":{"line":null,"column":-1}},"loc":{"start":{"line":22,"column":20},"end":{"line":22,"column":0}}},"5":{"name":"(anonymous_6)","decl":{"start":{"line":23,"column":44},"end":{"line":null,"column":-1}},"loc":{"start":{"line":23,"column":44},"end":{"line":23,"column":2}}},"6":{"name":"(anonymous_7)","decl":{"start":{"line":26,"column":22},"end":{"line":null,"column":-1}},"loc":{"start":{"line":26,"column":22},"end":{"line":26,"column":0}}},"7":{"name":"(anonymous_8)","decl":{"start":{"line":27,"column":46},"end":{"line":null,"column":-1}},"loc":{"start":{"line":27,"column":46},"end":{"line":27,"column":2}}},"8":{"name":"(anonymous_9)","decl":{"start":{"line":30,"column":23},"end":{"line":null,"column":-1}},"loc":{"start":{"line":30,"column":23},"end":{"line":30,"column":0}}},"9":{"name":"(anonymous_10)","decl":{"start":{"line":31,"column":36},"end":{"line":null,"column":-1}},"loc":{"start":{"line":31,"column":36},"end":{"line":31,"column":2}}}},"branchMap":{},"s":{"0":1,"1":1,"2":1,"3":1,"4":1,"5":1,"6":1,"7":1,"8":1,"9":1,"10":1,"11":1,"12":1,"13":1,"14":1,"15":1,"16":1,"17":1,"18":1,"19":1},"f":{"0":1,"1":1,"2":1,"3":1,"4":1,"5":1,"6":1,"7":1,"8":1,"9":1},"b":{}},"C:\\Users\\raphael.freitas\\Documents\\GitHub\\fitch.js\\src\\index.js":{"path":"C:\\Users\\raphael.freitas\\Documents\\GitHub\\fitch.js\\src\\index.js","statementMap":{"0":{"start":{"line":2,"column":18},"end":{"line":2,"column":39}},"1":{"start":{"line":4,"column":10},"end":{"line":4,"column":59}},"2":{"start":{"line":6,"column":15},"end":{"line":6,"column":34}},"3":{"start":{"line":8,"column":0},"end":{"line":44,"column":1}},"4":{"start":{"line":10,"column":4},"end":{"line":10,"column":40}},"5":{"start":{"line":14,"column":4},"end":{"line":14,"column":41}},"6":{"start":{"line":18,"column":4},"end":{"line":18,"column":40}},"7":{"start":{"line":22,"column":4},"end":{"line":22,"column":42}},"8":{"start":{"line":26,"column":4},"end":{"line":26,"column":43}},"9":{"start":{"line":30,"column":19},"end":{"line":30,"column":45}},"10":{"start":{"line":31,"column":4},"end":{"line":31,"column":42}},"11":{"start":{"line":35,"column":4},"end":{"line":37,"column":5}},"12":{"start":{"line":36,"column":6},"end":{"line":36,"column":24}},"13":{"start":{"line":38,"column":4},"end":{"line":38,"column":59}},"14":{"start":{"line":42,"column":4},"end":{"line":42,"column":32}}},"fnMap":{},"branchMap":{"0":{"loc":{"start":{"line":4,"column":10},"end":{"line":4,"column":59}},"type":"cond-expr","locations":[{"start":{"line":4,"column":42},"end":{"line":4,"column":51}},{"start":{"line":4,"column":54},"end":{"line":4,"column":59}}]},"1":{"loc":{"start":{"line":35,"column":4},"end":{"line":37,"column":5}},"type":"if","locations":[{"start":{"line":35,"column":4},"end":{"line":37,"column":5}},{"start":{"line":35,"column":4},"end":{"line":37,"column":5}}]}},"s":{"0":1,"1":1,"2":1,"3":1,"4":1,"5":1,"6":1,"7":1,"8":1,"9":5,"10":5,"11":5,"12":5,"13":0,"14":0},"f":{},"b":{"0":[1,0],"1":[5,0]},"hash":"2dc6bbf75283ec7bb57a102b8af6878786359bd0"},"C:\\Users\\raphael.freitas\\Documents\\GitHub\\fitch.js\\src\\config.js":{"path":"C:\\Users\\raphael.freitas\\Documents\\GitHub\\fitch.js\\src\\config.js","statementMap":{"0":{"start":{"line":1,"column":0},"end":{"line":19,"column":1}},"1":{"start":{"line":11,"column":4},"end":{"line":17,"column":5}}},"fnMap":{},"branchMap":{"0":{"loc":{"start":{"line":4,"column":4},"end":{"line":9,"column":10}},"type":"default-arg","locations":[{"start":{"line":9,"column":8},"end":{"line":9,"column":10}}]},"1":{"loc":{"start":{"line":5,"column":6},"end":{"line":5,"column":15}},"type":"default-arg","locations":[{"start":{"line":5,"column":13},"end":{"line":5,"column":15}}]},"2":{"loc":{"start":{"line":6,"column":6},"end":{"line":6,"column":23}},"type":"default-arg","locations":[{"start":{"line":6,"column":14},"end":{"line":6,"column":23}}]},"3":{"loc":{"start":{"line":7,"column":6},"end":{"line":7,"column":54}},"type":"default-arg","locations":[{"start":{"line":7,"column":16},"end":{"line":7,"column":54}}]},"4":{"loc":{"start":{"line":8,"column":6},"end":{"line":8,"column":19}},"type":"default-arg","locations":[{"start":{"line":8,"column":13},"end":{"line":8,"column":19}}]}},"s":{"0":1,"1":5},"f":{},"b":{"0":[2],"1":[2],"2":[5],"3":[5],"4":[5]},"hash":"898c33fbdaa78bbaf1b6d1d0f7f2e8c8c5e16fdf"}}

New alerts

Network access

Supply chain risk

This module accesses the network.

Found 1 instance in 1 package

Fixed alerts

Network access

Supply chain risk

This module accesses the network.

Found 1 instance in 1 package

Improved metrics

Number of lines in readme file

90

650%

Worsened metrics

Total package byte prevSize

3929

-67.65%

Number of package files

7

-30%

No dependency changes