scharff 1.0.0 → 1.1.0

package/README.md

@@ -7,11 +7,33 @@ The project is using the fetch-intercept NPM package.
 2) fork the git repository `https://github.com/Minka1902/scharff.git`, and place it next to your project.
 
 ## Usage
-1) in your entry point, import unregister from the package: `const { unregister } = require('../../scharff/index');`
-2) to stop the logger just run the unregister function: `unregister()`
+1) in your entry point, import unregister from the package: `const { unregister } = require('scharff');`
+2) to stop the logger just run the unregister function: `unregister()`, or `npm uninstall scharff`.
 
 ## What to expect
-The package will create a outgoingRequest.log file and start logging the requests to the file.
+1) The package will create a outgoingRequest.log file and start logging the requests to the file.
+2) In there you can see the fetch requests you sent.
+3) The request will be in the format below:</br>
+{</br>
+&nbsp;&nbsp;&nbsp;&nbsp;    "url":"http://www.example.com/update/ad423kbr1om82hu3d58a73g4",</br>
+&nbsp;&nbsp;&nbsp;&nbsp;    "originUrl":"/update/ad423kbr1om82hu3d58a73g4",</br>
+&nbsp;&nbsp;&nbsp;&nbsp;    "method":"GET",</br>
+&nbsp;&nbsp;&nbsp;&nbsp;    "headers":   </br>
+&nbsp;&nbsp;&nbsp;&nbsp;    {</br>
+&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;        "Content-Type":"application/json",</br>
+&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;        "Access-Control-Allow-Origin":"*"</br>
+&nbsp;&nbsp;&nbsp;&nbsp;    },</br>
+&nbsp;&nbsp;&nbsp;&nbsp;    "body":      </br>
+&nbsp;&nbsp;&nbsp;&nbsp;    {</br>
+&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;        "isActive":true,</br>
+&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;        "status":200,</br>
+&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;        "date":"2023-08-21T11:25:47.023Z"</br>
+&nbsp;&nbsp;&nbsp;&nbsp;    }</br>
+}
+
+## Next release
+1) Adding the date and time to the log.
+2) Adding the IP address to the log.
 
 ## Future additions
 1) We will add a request error logger.

package/index.js

@@ -5,8 +5,10 @@ const { removeBaseUrl } = require('./constants/functions');
 module.exports.unregister = fetchIntercept.register({
   request: function (url, config) {
     let tempUrl = url;
-    tempUrl = removeBaseUrl(tempUrl);
     let tempReq = { url };
+    let date = new Date().toLocaleString();
+    tempReq.date = date;
+    tempUrl = removeBaseUrl(tempUrl);
     if (tempUrl !== url) {
       tempReq.originUrl = tempUrl;
     }

package/package.json

@@ -1,11 +1,23 @@
 {
   "name": "scharff",
-  "version": "1.0.0",
+  "version": "1.1.0",
   "description": "Logger for outgoing requests",
   "main": "index.js",
   "scripts": {
     "test": "echo \"Error: no test specified\" && exit 1"
   },
+  "keywords": [
+    "logger",
+    "outgoing",
+    "request",
+    "response",
+    "error",
+    "fetch",
+    "fetch-inspector",
+    "inspector",
+    "scharff",
+    "npm"
+  ],
   "repository": {
     "type": "git",
     "url": "https://github.com/Minka1902/scharff.git"
@@ -15,4 +27,4 @@
   "dependencies": {
     "fetch-intercept": "^2.4.0"
   }
-}
+}