Use objects as poor man's keyword arguments for some functions
Open
Nobody has claimed this yet.
help wanted
kind/refactor
size/S
- Dominant language
- TypeScript
- Stars
- 15.2k
- Forks
- 1.5k
- Avg merge
- 3d 18h
- Merged PRs (30d)
- 6
Description
A couple of our functions have a few trailing boolean arguments, which makes invocations impossible to read.
Make these arguments into objects and use destructuring to improve readability.
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
The issue does not name specific files or functions. Search the TypeScript codebase for functions with multiple trailing boolean arguments, then inspect their call sites and existing tests; done means the selected arguments are passed as objects and destructured without changing behavior.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- typescript
- Domain
- tooling
- Issue type
- Refactor
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 35/100