fix: simplify http client #35
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
achingbrain
force-pushed
the
fix/simplify-http-client
branch
from
acbf480
to
835eb89
Compare
jacobheun
approved these changes
Apr 9, 2020
The conventions in the Fetch API is that you make a request, then do something
with the response:
```javascript
const response = await fetch('...')
const data = await response.json()
```
It doesn't do things like:
```javascript
const data = await fetch.json('...') // what method would this use?
```
This PR brings our API more inline with Fetch so where we used to do:
```javascript
for await (const datum of http.ndjson('...')) { // what method does this use?
}
```
We now do the more idiomatic:
```javascript
const response = await http.post('...')
for await (const datum of response.ndjson()) {
}
```
It also removes the `.iterator` and `.stream` methods as they do not
follow the Fetch pattern either though they can be added to the response
object if they are useful.
BREAKING CHANGE:
- The `.ndjson`, `.stream` and `.iterator` methods have been removed
- An `.ndjson` async generator function has been added to the response which
does the same thing the `.ndjson` instance method used to
Old:
```javascript
for await (const datum of http.ndjson('http://...')) {
}
```
New:
```javascript
const response = await http.post('http://...')
for await (const datum of response.ndjson()) {
}
```
achingbrain
force-pushed
the
fix/simplify-http-client
branch
from
835eb89
to
7fcc869
Compare
|
I've updated the commit message to include a BREAKING CHANGE section |
hugomrdias
approved these changes
Apr 9, 2020
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
The conventions in the Fetch API is that you make a request, then do something with the response:
It doesn't do things like:
This PR brings our API more inline with Fetch so where we used to do:
We now do the more idiomatic:
It also removes the
.iteratorand.streammethods as they do not follow the Fetch pattern either though they can be added to the response object if they are useful.