planetscale/database-js

Strongly type "type" property of Field

Open

#141 opened on Sep 24, 2023

View on GitHub
 (1 comment) (1 reaction) (0 assignees)TypeScript (40 forks)github user discovery
enhancementgood first issue

Repository metrics

Stars
 (1,197 stars)
PR merge metrics
 (PR metrics pending)

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

Research direction
Look at the Field type definition and replace the string type with a union of literal string types for supported database field types.
Tech stack
typescript
Domain
database
Issue type
Refactor
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
1
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Under 1 hour
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
TypeScript
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
85