axios-timing - npm Package Compare versions

Comparing version 1.0.0 to 1.0.1

package.json

 {
   "name": "axios-timing",
-  "version": "1.0.0",
+  "version": "1.0.1",
   "description": "Axios plugin to measure the actual time it takes for a request to complete",
@@ -5,0 +5,0 @@ "main": "index.js",

README.md

 # axios-timing
-Axios plugin to measure the actual time it takes between requests
+Axios plugin to measure the actual time it takes for a request to complete
+
+## Installation
+You can install this plugin using **Yarn** or **NPM**
+```bash
+yarn add axios-timing
+# - or - 
+npm install axios-timing
+```
+
+## Basic Usage
+The example below will log all request times out to the console...
+```js
+import axios
+import axiosTiming from './axios-timing'
+
+axiosTiming(axios, console.log)
+```
+
+### Axios Instance
+If you are using an axios instance, you should pass this through as the first argument
+```js
+import axios
+import axiosTiming from './axios-timing'
+
+const instance = axios.create()
+axiosTiming(instance, console.log)
+```
+
+### Custom Callback
+You can pass through a custom callback as your second arguement
+```js
+import axios
+import axiosTiming from './axios-timing'
+
+axiosTiming(axios, timeInMs => console.log(`${timeInMs.toFixed}ms`))
+```

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

2909

increased by37.02%

Number of lines in readme file

38

increased by1166.67%

No dependency changes