medikoo / medikoo/type

Rename "Error" option to "errorConstructor"

Open
#2 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

enhancement
Dominant language
JavaScript
Stars
37
Forks
4
PR merge metrics
No merged PRs in 30d

Description

options.errorConstructor feels more intuitive than options.Error

Rename should be introduced as breaking change

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

No files or tests are named in the issue. Start by locating the public options handling and every use of options.Error, then check how the package exposes and documents that option. Done means the option is consistently named errorConstructor and the breaking change is reflected wherever the old name is defined or tested.

Written by the indexing model from the issue text.

Assessment

Tech stack
javascript
Domain
api
Issue type
Refactor
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
28/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.