microsoft / microsoft/TypeScript
Update Pick to use new key remapping in mapped types
Nobody has claimed this yet.
- Dominant language
- Go
- Stars
- 111k
- Forks
- 14.3k
- Avg merge
- 2d 4h
- Merged PRs (30d)
- 132
Description
Search Terms
pick omit key remapping
Suggestion
Update Pick in lib.d.ts to be:
type Pick<T, K extends keyof T> = {
[P in keyof T as Extract<P, K>]: T[P];
};
It is currently defined as:
type Pick<T, K extends keyof T> = {
[P in K]: T[P];
};
Use Cases
With this new definition, typescript can statically analyze the keys, which allows interfaces to extends these types.
Examples
interface Base {
a: number,
b: string,
c: boolean,
}
// Errors: "An interface can only extend an object type or intersection of object types with statically known members"
interface PickBase0<K extends keyof Base> extends Pick<Base, K> {
pickedKeys: K
}
type Pick1<T, K extends keyof T> = { [L in keyof T as Extract<L, K>]: T[L] }
// Works
interface PickBase1<K extends keyof Base> extends Pick1<Base, K> {
pickedKeys: K
}
Checklist
My suggestion meets these guidelines:
- This wouldn't be a breaking change in existing TypeScript/JavaScript code
- This wouldn't change the runtime behavior of existing JavaScript code
- This could be implemented without emitting different JS based on the types of the expressions
- This isn't a runtime feature (e.g. library functionality, non-ECMAScript syntax with JavaScript output, etc.)
- This feature would agree with the rest of TypeScript's Design Goals.
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 inspecting the current Pick definition in lib.d.ts and reproduce the linked Playground example involving mapped types and interface extension. Compare the proposed key-remapping definition with the existing behavior; done means the example works without breaking existing Pick behavior and the relevant TypeScript checks pass.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- typescript
- Domain
- compilers
- Issue type
- Feature
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 35/100