undici
undici copied to clipboard
Documentation: RequestOptions
Bug Description
Documentation about RequestOptions is inconsistent.
Reproducible By
Comparing the following:
https://github.com/nodejs/undici#undicirequesturl-options-promise
https://github.com/nodejs/undici/blob/main/docs/api/Dispatcher.md#parameter-requestoptions
https://github.com/nodejs/undici/blob/main/docs/api/Dispatcher.md#parameter-dispatchoptions
https://github.com/nodejs/undici/blob/main/types/api.d.ts#L16
Expected Behavior
Expected consistent types in code and in documentation. Specifically, are we allowed to specify origin
and path
in the options object passed as the second argument to request
and friends? Why or why not?