Skip to content

Commit

Permalink
v1.0.6 Added an ipAddress parameter
Browse files Browse the repository at this point in the history
  • Loading branch information
obayomi96 committed Jul 19, 2024
1 parent 6d9f35f commit 675fb2e
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 3 deletions.
6 changes: 4 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,8 @@ console.log(result.data);
// IP address with all network information
const result = await getIpAddressAndNetworkInfo('apikey', '8.8.8.8');
// The IP address parameter is optional
// getIpAddressAndNetworkInfo('apikey');

console.log(result.data);
//=> {
// "ip": "8.8.8.8",
Expand All @@ -58,7 +60,7 @@ console.log(result.data);
// "isp": "Google LLC"
// }
```
> See live example usage [here](jetvisionv3.netlify.app)
> See live example usage [here](https://jetvisionv3.netlify.app/dashboard)
## API

Expand All @@ -67,4 +69,4 @@ console.log(result.data);
### getIpAddressAndNetworkInfo(apiKey, ipAddress?)

> Returns a `Promise<object>` with an object containing your ip address and other network and device information. You need to add an API key. For this example you can add an optional ipAddress parameter if the IP you want to check is a specific IP address.
> Returns a `Promise<object>` with an object containing your ip address and other network and device information, for this you need to add an API key. You can add an optional ipAddress parameter if the IP you want to check is a specific IP address.
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
{
"version": "1.0.5",
"version": "1.0.6",
"license": "MIT",
"main": "dist/index.js",
"typings": "dist/index.d.ts",
Expand Down

0 comments on commit 675fb2e

Please sign in to comment.