planetscale / planetscale/database-js
Strongly type "type" property of Field
Open
Beginner friendly
Nobody has claimed this yet.
enhancement
good first issue
- Dominant language
- TypeScript
- Stars
- 1.2k
- Forks
- 42
- PR merge metrics
- No merged PRs in 30d
Description
Rather than having the type of "type" Field be of type string, it should be 'INT8' | 'INT16' | ... | string to make it easier to infer what type to check
Contributor guide
No contributing guide indexed for this repository
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 TypeScript definition of the Field type and inspect how its type property is currently declared and consumed. Update the type so known values can be inferred while arbitrary strings remain accepted, then run the repository's existing type checks and tests to confirm compatibility.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- typescript
- Domain
- databases
- Issue type
- Feature
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Quiet
- Clarity
- Mostly clear
- Newbie friendliness
- 65/100