Skip to content

Commit 82495d5

Browse files
committed
Minor tweaks
1 parent dd27622 commit 82495d5

File tree

1 file changed

+5
-3
lines changed

1 file changed

+5
-3
lines changed

readme.md

+5-3
Original file line numberDiff line numberDiff line change
@@ -6,8 +6,8 @@ Useful if you need a local server to be ready to accept requests before doing ot
66

77
## Install
88

9-
```
10-
$ npm install wait-for-localhost
9+
```sh
10+
npm install wait-for-localhost
1111
```
1212

1313
## Usage
@@ -23,7 +23,9 @@ console.log('Server is ready');
2323

2424
### waitForLocalHost(options?)
2525

26-
Returns a `Promise` that settles when localhost is ready.
26+
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.
2729

2830
#### options
2931

0 commit comments

Comments
 (0)