[doc] Document that the returned hostname might be invalid

unshiftio · Feb 11, 2022 · 4e53a8c · 4e53a8c
1 parent f7774f6
commit 4e53a8c
Showing 1 changed file with 2 additions and 2 deletions.
diff --git a/README.md b/README.md
@@ -80,8 +80,8 @@ The returned `url` instance contains the following properties:
 - `auth`: Authentication information portion (e.g. `username:password`).
 - `username`: Username of basic authentication.
 - `password`: Password of basic authentication.
-- `host`: Host name with port number.
-- `hostname`: Host name without port number.
+- `host`: Host name with port number. The hostname might be invalid.
+- `hostname`: Host name without port number. This might be an invalid hostname.
 - `port`: Optional port number.
 - `pathname`: URL path.
 - `query`: Parsed object containing query string, unless parsing is set to false.