Skip to content

Commit 4e53a8c

Browse files
committedFeb 11, 2022
[doc] Document that the returned hostname might be invalid
1 parent f7774f6 commit 4e53a8c

File tree

1 file changed

+2
-2
lines changed

1 file changed

+2
-2
lines changed
 

‎README.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -80,8 +80,8 @@ The returned `url` instance contains the following properties:
8080
- `auth`: Authentication information portion (e.g. `username:password`).
8181
- `username`: Username of basic authentication.
8282
- `password`: Password of basic authentication.
83-
- `host`: Host name with port number.
84-
- `hostname`: Host name without port number.
83+
- `host`: Host name with port number. The hostname might be invalid.
84+
- `hostname`: Host name without port number. This might be an invalid hostname.
8585
- `port`: Optional port number.
8686
- `pathname`: URL path.
8787
- `query`: Parsed object containing query string, unless parsing is set to false.

0 commit comments

Comments
 (0)
Please sign in to comment.