Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

feat(types): fix props JSDoc loss #935

Merged
merged 2 commits into from May 18, 2022
Merged

feat(types): fix props JSDoc loss #935

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
83470b2
feat(types): simplify `ExtractPropTypes` to avoid props JSDocs being …
xiaoxiangmoe May 18, 2022
043ef26
feat(types): avoid props JSDocs loss due to `default` option
xiaoxiangmoe May 18, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
15 changes: 9 additions & 6 deletions src/component/componentProps.ts
View file
Open in desktop
Expand Up @@ -69,11 +69,13 @@ type InferPropType<T> = T extends null
: ExtractCorrectPropType<V>
: T

export type ExtractPropTypes<O> = O extends object
? { [K in RequiredKeys<O>]: InferPropType<O[K]> } & {
[K in OptionalKeys<O>]?: InferPropType<O[K]>
}
: { [K in string]: any }
export type ExtractPropTypes<O> = {
// use `keyof Pick<O, RequiredKeys<O>>` instead of `RequiredKeys<O>` to support IDE features
[K in keyof Pick<O, RequiredKeys<O>>]: InferPropType<O[K]>
} & {
// use `keyof Pick<O, OptionalKeys<O>>` instead of `OptionalKeys<O>` to support IDE features
[K in keyof Pick<O, OptionalKeys<O>>]?: InferPropType<O[K]>
}

type DefaultKeys<T> = {
[K in keyof T]: T[K] extends
Expand All @@ -93,5 +95,6 @@ type DefaultKeys<T> = {

// extract props which defined with default from prop options
export type ExtractDefaultPropTypes<O> = O extends object
? { [K in DefaultKeys<O>]: InferPropType<O[K]> }
? // use `keyof Pick<O, DefaultKeys<O>>` instead of `DefaultKeys<O>` to support IDE features
{ [K in keyof Pick<O, DefaultKeys<O>>]: InferPropType<O[K]> }
: {}