Skip to content

Commit

Permalink
fix(types): allow assigning wider SetupContext type (#2818)
Browse files Browse the repository at this point in the history
fix #2362
  • Loading branch information
sapphi-red authored Nov 14, 2022
1 parent 588bd44 commit eb2a832
Show file tree
Hide file tree
Showing 2 changed files with 20 additions and 7 deletions.
15 changes: 9 additions & 6 deletions packages/runtime-core/src/component.ts
Original file line number Diff line number Diff line change
Expand Up @@ -180,12 +180,15 @@ export const enum LifecycleHooks {
SERVER_PREFETCH = 'sp'
}

export interface SetupContext<E = EmitsOptions> {
attrs: Data
slots: Slots
emit: EmitFn<E>
expose: (exposed?: Record<string, any>) => void
}
// use `E extends any` to force evaluating type to fix #2362
export type SetupContext<E = EmitsOptions> = E extends any
? {
attrs: Data
slots: Slots
emit: EmitFn<E>
expose: (exposed?: Record<string, any>) => void
}
: never

/**
* @internal
Expand Down
12 changes: 11 additions & 1 deletion test-dts/component.test-d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,9 @@ import {
FunctionalComponent,
ComponentPublicInstance,
toRefs,
IsAny
IsAny,
SetupContext,
expectAssignable
} from './index'

declare function extractComponentOptions<Props, RawBindings>(
Expand Down Expand Up @@ -476,3 +478,11 @@ describe('class', () => {

expectType<number>(props.foo)
})

describe('SetupContext', () => {
describe('can assign', () => {
const wider: SetupContext<{ a: () => true; b: () => true }> = {} as any

expectAssignable<SetupContext<{ b: () => true }>>(wider)
})
})

0 comments on commit eb2a832

Please sign in to comment.