Docs

Author: IonicaBizau

lib/index.js

@@ -9,16 +9,17 @@ const protocols = require("protocols")
  * @param {String} url The input url.
  * @return {Object} An object containing the following fields:
  *
- *  - `protocols` (Array): An array with the url protocols (usually it has one element).
- *  - `protocol` (String): The first protocol, `"ssh"` (if the url is a ssh url) or `"file"`.
- *  - `port` (null|Number): The domain port.
- *  - `resource` (String): The url domain (including subdomains).
- *  - `user` (String): The authentication user (usually for ssh urls).
- *  - `pathname` (String): The url pathname.
- *  - `hash` (String): The url hash.
- *  - `search` (String): The url querystring value.
- *  - `href` (String): The input url.
- *  - `query` (Object): The url querystring, parsed as object.
+ *    - `protocols` (Array): An array with the url protocols (usually it has one element).
+ *    - `protocol` (String): The first protocol or `"file"`.
+ *    - `port` (null|Number): The domain port.
+ *    - `resource` (String): The url domain (including subdomain and port).
+ *    - `user` (String): The authentication user (default: `""`).
+ *    - `password` (String): The authentication password (default: `""`).
+ *    - `pathname` (String): The url pathname.
+ *    - `hash` (String): The url hash.
+ *    - `search` (String): The url querystring value (excluding `?`).
+ *    - `href` (String): The normalized input url.
+ *    - `query` (Object): The url querystring, parsed as object.
  */
 function parsePath(url) {