Skip to content

Commit f63cbfa

Browse files
authored
Update README.md
1 parent c811605 commit f63cbfa

1 file changed

Lines changed: 3 additions & 3 deletions

File tree

README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -221,7 +221,7 @@ If the host argument was given with a host name, this host name will be remember
221221
| `rtt` | `number` | When the `status` is not `PingStatus.ECHO`, the value will be -1 (`NO_ECHO_RTT`)
222222
| `ttl` | `number` | When the `status` is not `PingStatus.ECHO`, the value will be -1 (`NO_ECHO_TTL`)
223223
| `status` | `PingStatus` | Full references at [PingStatus](#pingstatus)
224-
| `isEnded` | `boolean` | `true` if there is a subsequent ping request coming.
224+
| `isEnded` | `boolean` | `true` if there is no subsequent ping requests.
225225

226226
#### ICMPConstructorData
227227
| Properties | Type | Remarks |
@@ -236,9 +236,9 @@ If the host argument was given with a host name, this host name will be remember
236236
#### UseICMP
237237
| Properties | Type | Remarks |
238238
| ------------- | ----------------------------------- | -------------------------------------------------------------------------------------------------------------- |
239-
| `isRunning` | `boolean` | A React state |
239+
| `isRunning` | `boolean` | A React state. `false` if there is no subsequent ping requests |
240240
| `result` | `ICMPResult` \| `undefined` | See [ICMPResult](#icmpresult)
241-
| `start` | `() => void` |
241+
| `start` | `() => void` | Start the ping process
242242
| `stop` | `() => void` | Stop the current running process. It does nothing when there is no processes.
243243

244244
#### UseICMPProps

0 commit comments

Comments
 (0)