Add migration guides #595
Add migration guides #595
Conversation
|
I think each migration should be a separate file. |
|
This PR is not my first priority right now, so it may take a while to finish this. |
| - No `oauth`/`hawk`/`aws`/`httpSignature` option. To sign requests, you need to create a [custom instance](advanced-creation.md#signing-requests). | ||
| - No `agentClass`/`agentOptions`/`forever`/`pool` option. | ||
| - No proxy option. You need to [pass a custom agent](readme.md#proxies). | ||
| - No `removeRefererHeader` option. You can remove the referer header in a [`beforeRequest` hook](https://github.com/sindresorhus/got#hooksbeforeRequest): |
There was a problem hiding this comment.
Also no maxRedirects option. There are many more too that are not listed here.
There was a problem hiding this comment.
I prefer to operate on parents, not children (options) :P
There was a problem hiding this comment.
I think it's more clear.
There was a problem hiding this comment.
I prefer to operate on parents, not children (options)
What does that mean?
There was a problem hiding this comment.
followRedirect - follow HTTP 3xx responses as redirects (default: true). This property can also be implemented as function which gets response object as a single argument and should return true if redirects should continue or false otherwise.
followAllRedirects - follow non-GET HTTP 3xx responses as redirects (default: false)
followOriginalHttpMethod - by default we redirect to HTTP method GET. you can enable this property to redirect to the original HTTP method (default: false)
It's counted as only one option: followRedirect. (followAllRedirects and followOriginalHttpMethod are the children of followRedirect, 'ya know what I mean?)
There was a problem hiding this comment.
Also, some Request's options are not spec-compliant.
There was a problem hiding this comment.
It's counted as only one option: followRedirect. (followAllRedirects and followOriginalHttpMethod are the children of followRedirect, 'ya know what I mean?)
Yes, but is that clear enough to the end-user though? Why not be explicit about it? Some might just do Cmd+F to try to find what they're looking for. I think we should list them all to make it easy to the user to discover.
Also, some Request's options are not spec-compliant.
Spec-compliant to what? HTTP? And does it matter? Then we list it and say that Got does not support that because it's not spec compliant.
There was a problem hiding this comment.
I did not say we should have no such feature because it isn't spec-compliant. I meant Got's more spec-compliant than Request. Anyway, nevermind. It doesn't matter. I'll just list them.
There was a problem hiding this comment.
I got (pun intended) what you meant. I just think we should list it no matter what.
migration-guides.md
Outdated
|
|
||
| - No `form` option. You have to pass a [`form-data` instance](https://github.com/form-data/form-data) through the [`body` option](https://github.com/sindresorhus/got#body). | ||
| - No `oauth`/`hawk`/`aws`/`httpSignature` option. To sign requests, you need to create a [custom instance](advanced-creation.md#signing-requests). | ||
| - No `agentClass`/`agentOptions`/`forever`/`pool` option. |
There was a problem hiding this comment.
Can we provide any transition steps / alternatives for these options?
There was a problem hiding this comment.
agent: new agentClass(agentOptions)pool implementation:
const agentSymbol = Symbol('agent');
const pools = new Map();
const getKeyFromPool = pool => ...; // TODO
const getAgent = (pool, options) => {
const merged = {...pool, ...options};
const key = getKeyFromPool(merged);
if (!pools.has(key)) {
pools.set(key, new specifiedAgentByUserOrDefault(pool));
}
return pools.get(key);
};
|
Can you link to this at the top of the readme with a link text like:
|
migration-guides.md
Outdated
| ], | ||
| afterResponse: [ | ||
| response => { | ||
| // TODO in Got: we need to make the `options` public somehow |
There was a problem hiding this comment.
@szmarczak Can you open a new issue about this?
|
Looking good :) Still some minor things left, but these things can be done in a follow-up PR: |
No description provided.