undici icon indicating copy to clipboard operation
undici copied to clipboard

Documentation: RequestOptions

Open rudolfbyker opened this issue 3 years ago • 0 comments

Bug Description

Documentation about RequestOptions is inconsistent.

Reproducible By

Comparing the following:

https://github.com/nodejs/undici#undicirequesturl-options-promise image

https://github.com/nodejs/undici/blob/main/docs/api/Dispatcher.md#parameter-requestoptions image

https://github.com/nodejs/undici/blob/main/docs/api/Dispatcher.md#parameter-dispatchoptions image

https://github.com/nodejs/undici/blob/main/types/api.d.ts#L16 image

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?

rudolfbyker avatar Aug 31 '21 09:08 rudolfbyker