Comparing version 1.2.0 to 1.2.1
## 1 August 2019 | ||
### [1.2.1](https://github.com/rqt/ip/compare/v1.2.0...v1.2.1) | ||
- [package] Fix documentation. | ||
### [1.2.0](https://github.com/rqt/ip/compare/v1.1.0...v1.2.0) | ||
@@ -4,0 +8,0 @@ |
{ | ||
"name": "@rqt/ip", | ||
"version": "1.2.0", | ||
"version": "1.2.1", | ||
"description": "Returns a public IP address of the host.", | ||
@@ -5,0 +5,0 @@ "main": "compile/index.js", |
@@ -19,3 +19,3 @@ # @rqt/ip | ||
- [API](#api) | ||
- [`ip(options?: Options)`](#ipoptions-options-void) | ||
- [`async ip(options?: Options): string`](#async-ipoptions-options-string) | ||
* [`_rqt.IpOptions`](#type-_rqtipoptions) | ||
@@ -40,3 +40,3 @@ - [Copyright](#copyright) | ||
## `ip(`<br/> `options?: Options,`<br/>`): void` | ||
## `async ip(`<br/> `options?: Options,`<br/>`): string` | ||
@@ -46,8 +46,19 @@ Returns the IP address as seen by an external web-server. | ||
<strong><a name="type-_rqtipoptions">`_rqt.IpOptions`</a></strong>: Options for the request. | ||
<table> | ||
<thead><tr> | ||
<th>Name</th> | ||
<th>Type & Description</th> | ||
<th>Default</th> | ||
</tr></thead> | ||
<tr> | ||
<td rowSpan="3" align="center">host</td> | ||
<td><em>string</em></td> | ||
<td rowSpan="3"><code>https://api.ipify.org</code></td> | ||
</tr> | ||
<tr></tr> | ||
<tr> | ||
<td>The address from which to get the IP address.</td> | ||
</tr> | ||
</table> | ||
| Name | Type | Description | Default | | ||
| ---- | --------------- | --------------------------------------------- | ----------------------- | | ||
| host | <em>string</em> | The address from which to get the IP address. | `https://api.ipify.org` | | ||
```js | ||
@@ -77,3 +88,3 @@ const GetIp = async (host) => { | ||
</th> | ||
<th>© <a href="https://artd.eco">Art Deco</a> for <a>Rqt</a> 2019</th> | ||
<th>© <a href="https://artd.eco">Art Deco</a> for <a href="https://rqt.biz">Rqt</a> 2019</th> | ||
<th> | ||
@@ -80,0 +91,0 @@ <a href="https://www.technation.sucks" title="Tech Nation Visa"> |
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
Major refactor
Supply chain riskPackage has recently undergone a major refactor. It may be unstable or indicate significant internal changes. Use caution when updating to versions that include significant changes.
Found 1 instance in 1 package
49874
98
2