We read every piece of feedback, and take your input very seriously.
To see all available qualifiers, see our documentation.
1 parent dd27622 commit 82495d5Copy full SHA for 82495d5
readme.md
@@ -6,8 +6,8 @@ Useful if you need a local server to be ready to accept requests before doing ot
6
7
## Install
8
9
-```
10
-$ npm install wait-for-localhost
+```sh
+npm install wait-for-localhost
11
```
12
13
## Usage
@@ -23,7 +23,9 @@ console.log('Server is ready');
23
24
### waitForLocalHost(options?)
25
26
-Returns a `Promise` that settles when localhost is ready.
+Returns a `Promise<object>` that settles when localhost is ready.
27
+
28
+The object contains a `ipVersion` property with a value of either `6` or `4` depending on the IP version that was used.
29
30
#### options
31
0 commit comments