Documentation: RequestOptions
Nobody has claimed this yet.
- Dominant language
- JavaScript
- Stars
- 7.7k
- Forks
- 880
- Avg merge
- 2d 16h
- Merged PRs (30d)
- 68
Description
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?
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by comparing the RequestOptions and DispatchOptions sections in docs/api/Dispatcher.md with the request API documentation and the RequestOptions definition in types/api.d.ts. Determine whether origin and path are supported in the options passed to request and related methods. Done means the documentation and TypeScript types consistently describe the supported options and explain any restriction.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- javascript
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100