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

types(withDefaults): enhance read-only type #8601

Merged
merged 2 commits into from
Nov 10, 2023
Merged

types(withDefaults): enhance read-only type #8601

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
1e8472e
types(withDefaults): add read-only type
zqran Jun 19, 2023
aff5f97
test: add tests
zqran Jun 19, 2023
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
5 changes: 5 additions & 0 deletions packages/dts-test/setupHelpers.test-d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -107,6 +107,7 @@ describe('defineProps w/ generic type declaration + withDefaults', <T extends nu
defineProps<{
n?: number
bool?: boolean
s?: string

generic1?: T[] | { x: T }
generic2?: { x: T }
Expand All @@ -125,6 +126,10 @@ describe('defineProps w/ generic type declaration + withDefaults', <T extends nu
)

res.n + 1
// @ts-expect-error should be readonly
res.n++
// @ts-expect-error should be readonly
res.s = ''

expectType<T[] | { x: T }>(res.generic1)
expectType<{ x: T }>(res.generic2)
Expand Down
4 changes: 2 additions & 2 deletions packages/runtime-core/src/apiSetupHelpers.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -297,8 +297,8 @@ type PropsWithDefaults<
T,
Defaults extends InferDefaults<T>,
BKeys extends keyof T
> = Omit<T, keyof Defaults> & {
[K in keyof Defaults]-?: K extends keyof T
> = Readonly<Omit<T, keyof Defaults>> & {
readonly [K in keyof Defaults]-?: K extends keyof T
? Defaults[K] extends undefined
? T[K]
: NotUndefined<T[K]>
Expand Down