Skip to content

types(defineProps): avoid never props becoming boolean flags #14059

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

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
+14 −2
Open

types(defineProps): avoid never props becoming boolean flags #14059

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
0600862
types(defineProps): avoid never props becoming boolean flags
edison1105 Nov 6, 2025
6079bdb
chore: update
edison1105 Nov 8, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 10 additions & 0 deletions packages-private/dts-test/setupHelpers.test-d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,16 @@ describe('defineProps w/ type declaration', () => {
expectType<boolean>(props.boolAndUndefined)
})

describe('defineProps w/ never prop', () => {
const props = defineProps<{
foo?: never
bar: number
}>()

expectType<never | undefined>(props.foo)
expectType<number>(props.bar)
})

describe('defineProps w/ generics', () => {
function test<T extends boolean>() {
const props = defineProps<{ foo: T; bar: string; x?: boolean }>()
Expand Down
6 changes: 4 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 @@ -98,8 +98,10 @@ export type DefineProps<T, BKeys extends keyof T> = Readonly<T> & {
}

type BooleanKey<T, K extends keyof T = keyof T> = K extends any
? [T[K]] extends [boolean | undefined]
? K
? T[K] extends boolean | undefined
? T[K] extends never | undefined
? never
: K
: never
: never

Expand Down
Loading