Skip to content

Commit 7dc87ac

Browse files
committed
Update README.md
1 parent f84b8bf commit 7dc87ac

File tree

1 file changed

+15
-4
lines changed

1 file changed

+15
-4
lines changed

README.md

Lines changed: 15 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -206,14 +206,25 @@ It's safe to unmount your component without invoke the `stop` method. This hook
206206
| **start** | `() => void` |
207207
| **stop** | `() => void` |
208208

209-
### getHostName
210-
> ⚠️ Not ready. It's for future release.
209+
#
210+
### getHostname
211+
`(host: string) => Promise<string | null>`
212+
213+
Gets the host name from an IP address.
214+
215+
If the host argument was given with a host name, a reverse name lookup still will be performed and the result will be returned based on the system configured name lookup service.
211216

217+
The Promise will never be rejected. It will return `null` if it fails.
218+
219+
#
220+
### getHostAddress
212221
`(host: string) => Promise<string | null>`
213222

214-
If the host argument was given with a host name, this host name will be remembered and returned; otherwise, a reverse name lookup will be performed and the result will be returned based on the system configured name lookup service.
215-
#
223+
Gets the host address from a host name. Returns the IP address string in textual presentation.
216224

225+
The Promise will never be rejected. It will return `null` if it fails.
226+
227+
#
217228
## Definitions
218229
#### ICMPResult
219230
| Properties | Type | Remarks |

0 commit comments

Comments
 (0)