restify / restify/node-restify
Review request and response public and private methods
Open
Nobody has claimed this yet.
Critical
- Dominant language
- JavaScript
- Stars
- 10.7k
- Forks
- 975
- Avg merge
- 1d 6h
- Merged PRs (30d)
- 5
Description
Use Case
Some Request and Response methods have both a naked and a get prefixed version as well while we document only one of them as @public. For example: href() and getHref()
We should review these methods and expose both versions or remove the unnecessary methods.
Are you willing and able to implement this?
Yes
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 locating the Request and Response method definitions and their public API documentation. Compare naked methods such as href() with get-prefixed variants such as getHref(), then decide whether both should be exposed or one removed. Done means the method set and @public documentation are consistent across Request and Response.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- javascript
- Domain
- api, backend-api-design
- Issue type
- Refactor
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 30/100