Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

doc: improve urlObject.auth text #22324

Closed
wants to merge 3 commits into from
Closed

doc: improve urlObject.auth text #22324

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
82357cb
doc: use italics for words-as-words
Trott Aug 14, 2018
a3b120f
doc: remove redundant explanation of format
Trott Aug 14, 2018
8f9e7bc
doc: simplify format description of urlObject.auth
Trott Aug 14, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions doc/api/url.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -919,10 +919,10 @@ The legacy `urlObject` (`require('url').Url`) is created and returned by the
#### urlObject.auth

The `auth` property is the username and password portion of the URL, also
referred to as "userinfo". This string subset follows the `protocol` and
double slashes (if present) and precedes the `host` component, delimited by an
ASCII "at sign" (`@`). The format of the string is `{username}[:{password}]`,
with the `[:{password}]` portion being optional.
referred to as _userinfo_. This string subset follows the `protocol` and
double slashes (if present) and precedes the `host` component, delimited by `@`.
The string is either the username, or it is the username and password separated
by `:`.

For example: `'user:pass'`.

Expand Down