Skip to content

Commit bb8a97d

Browse files
authored
Update README.md
1 parent 3f59f39 commit bb8a97d

1 file changed

Lines changed: 5 additions & 5 deletions

File tree

README.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -148,7 +148,7 @@ export default function App(): React.JSX.Element {
148148
| ------------------- | ----------------- | ----------------- | ----------------------------------------------------------------------------------------------------------- |
149149
| **NO_ECHO_RTT** | `number` | -1 | Just an constant whenever the status of ping result is not `ICMPStatus.ECHO`. It is used in the rtt result. |
150150
| **NO_ECHO_TTL** | `number` | -1 | Just an constant whenever the status of ping result is not `ICMPStatus.ECHO`. It is used in the ttl result. |
151-
| **Status** | `ICMPStatus` | `ICMPStatus` | - |
151+
| **Status** | `enum` | `ICMPStatus` | See [ICMPStatus](#icmpstatus). |
152152

153153
:warning::warning::warning: **Important!**
154154

@@ -190,7 +190,7 @@ It's safe to unmount your component without invoke the `stop` method. This hook
190190
| Properties | Type | Remarks |
191191
| ------------- | ------------- | ---------------------------------------------------------------------------------- |
192192
| **isRunning** | `boolean` |
193-
| **result** | `ICMPResult` | See [ICMPResult](#icmpresult)
193+
| **result** | `object` | See [ICMPResult](#icmpresult)
194194

195195
#
196196
### getHostname
@@ -217,7 +217,7 @@ The Promise will never be rejected. It will return `null` if it fails.
217217
| ------------- | --------------------------------- | ---------------------------------------------------------------------------------- |
218218
| `rtt` | `number` | When the `status` is not `ICMPStatus.ECHO`, the value will be -1 (`NO_ECHO_RTT`)
219219
| `ttl` | `number` | When the `status` is not `ICMPStatus.ECHO`, the value will be -1 (`NO_ECHO_TTL`)
220-
| `status` | `ICMPStatus` | Full references at [ICMPStatus](#icmpstatus)
220+
| `status` | `enum` | See [ICMPStatus](#icmpstatus).
221221
| `isEnded` | `boolean` | `true` if there is no subsequent ping requests.
222222

223223
#### ICMPConstructorData
@@ -234,7 +234,7 @@ The Promise will never be rejected. It will return `null` if it fails.
234234
| Properties | Type | Remarks |
235235
| ------------- | ----------------------------------- | -------------------------------------------------------------------------------------------------------------- |
236236
| `isRunning` | `boolean` | A React state. `false` if there is no subsequent ping requests |
237-
| `result` | `ICMPResult` \| `undefined` | See [ICMPResult](#icmpresult)
237+
| `result` | `object` \| `undefined` | See [ICMPResult](#icmpresult)
238238

239239
#### UseICMPProps
240240
It extends [ICMPConstructorData](#icmpconstructordata).
@@ -243,7 +243,7 @@ It extends [ICMPConstructorData](#icmpconstructordata).
243243
| Member | Value | Remarks |
244244
| ------------------------------ | -------------- | ------------------------------------------------------------------------------------ |
245245
| `ECHO` | `2` | Success
246-
| `ECHOING` | `1` | When the `ping` method or `start` is invoked when the previous process still running
246+
| `ECHOING` | `1` | When the `ping` method is invoked when the previous process still running
247247
| `TIMEDOUT` | `0` |
248248
| `INVALID_ARG` | `-1` | Invalid argument. such as illegal packet size, ttl out of range.
249249
| `UNKNOWN_HOST` | `-2` |

0 commit comments

Comments
 (0)