Skip to content

Commit

Permalink
fix(types): improve return type withKeys and withModifiers (#9734)
Browse files Browse the repository at this point in the history
  • Loading branch information
pikax authored Dec 3, 2023
1 parent 9ea2b86 commit 43c3cfd
Show file tree
Hide file tree
Showing 2 changed files with 19 additions and 9 deletions.
10 changes: 9 additions & 1 deletion packages/dts-test/defineComponent.test-d.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,9 @@ import {
h,
SlotsType,
Slots,
VNode
VNode,
withKeys,
withModifiers
} from 'vue'
import { describe, expectType, IsUnion } from './utils'

Expand Down Expand Up @@ -1497,6 +1499,12 @@ describe('should work when props type is incompatible with setup returned type '
expectType<SizeType>(CompA.$props.size)
})

describe('withKeys and withModifiers as pro', () => {
const onKeydown = withKeys(e => {}, [''])
const onClick = withModifiers(e => {}, [''])
;<input onKeydown={onKeydown} onClick={onClick} />
})

import {
DefineComponent,
ComponentOptionsMixin,
Expand Down
18 changes: 10 additions & 8 deletions packages/runtime-dom/src/directives/vOn.ts
Original file line number Diff line number Diff line change
Expand Up @@ -32,19 +32,21 @@ const modifierGuards: Record<
/**
* @private
*/
export const withModifiers = (
fn: Function & { _withMods?: Function },
export const withModifiers = <
T extends (event: Event, ...args: unknown[]) => any
>(
fn: T & { _withMods?: T },
modifiers: string[]
) => {
return (
fn._withMods ||
(fn._withMods = (event: Event, ...args: unknown[]) => {
(fn._withMods = ((event, ...args) => {
for (let i = 0; i < modifiers.length; i++) {
const guard = modifierGuards[modifiers[i]]
if (guard && guard(event, modifiers)) return
}
return fn(event, ...args)
})
}) as T)
)
}

Expand All @@ -63,8 +65,8 @@ const keyNames: Record<string, string | string[]> = {
/**
* @private
*/
export const withKeys = (
fn: Function & { _withKeys?: Function },
export const withKeys = <T extends (event: KeyboardEvent) => any>(
fn: T & { _withKeys?: T },
modifiers: string[]
) => {
let globalKeyCodes: LegacyConfig['keyCodes']
Expand All @@ -88,7 +90,7 @@ export const withKeys = (

return (
fn._withKeys ||
(fn._withKeys = (event: KeyboardEvent) => {
(fn._withKeys = (event => {
if (!('key' in event)) {
return
}
Expand Down Expand Up @@ -123,6 +125,6 @@ export const withKeys = (
}
}
}
})
}) as T)
)
}

0 comments on commit 43c3cfd

Please sign in to comment.