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.

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

doc: special cases in http module response body #8992

Closed
wants to merge 1 commit into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
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
3 changes: 3 additions & 0 deletions doc/api/http.md
Original file line number Diff line number Diff line change
Expand Up @@ -1015,6 +1015,9 @@ it will switch to implicit header mode and flush the implicit headers.
This sends a chunk of the response body. This method may
be called multiple times to provide successive parts of the body.

Note that in `http` module, the response body is omitted when the request is a
HEAD. Similarly, The `204` and `304` responses MUST NOT include a message body.

`chunk` can be a string or a buffer. If `chunk` is a string,
the second parameter specifies how to encode it into a byte stream.
By default the `encoding` is `'utf8'`. `callback` will be called when this chunk
Expand Down
13 changes: 13 additions & 0 deletions doc/api/url.md
Original file line number Diff line number Diff line change
Expand Up @@ -235,6 +235,19 @@ url.resolve('http://example.com/', '/one') // 'http://example.com/one'
url.resolve('http://example.com/one', '/two') // 'http://example.com/two'
```

Note that `url.resolve()` method depends on the protocol given in the `from` parameter.
Some protocols like `https`, `file`, `ftp`, `wss` and `gopher` have special cases.

For example:

```js
url.resolve('https://foo.tld', 'bar') // 'https://foo.tld/bar'
url.resolve('wss://foo.tld', 'bar') // 'wss://bar'
url.resolve('ftps://foo.tld', 'bar') // 'ftps://bar'
```

Although, the uniform behaviour of the method is achieved when the URL ends with a slash.

## Escaped Characters

URLs are only permitted to contain a certain range of characters. Spaces (`' '`)
Expand Down