128 lines
3.5 KiB
TypeScript
128 lines
3.5 KiB
TypeScript
import {
|
|
ComputedOptions,
|
|
MethodOptions,
|
|
ComponentOptionsWithoutProps,
|
|
ComponentOptionsWithArrayProps,
|
|
ComponentOptionsWithObjectProps
|
|
} from './componentOptions'
|
|
import { SetupContext, RenderFunction, FunctionalComponent } from './component'
|
|
import { ComponentPublicInstance } from './componentProxy'
|
|
import { ExtractPropTypes, ComponentPropsOptions } from './componentProps'
|
|
import { EmitsOptions } from './componentEmits'
|
|
import { isFunction } from '@vue/shared'
|
|
import { VNodeProps } from './vnode'
|
|
|
|
// defineComponent is a utility that is primarily used for type inference
|
|
// when declaring components. Type inference is provided in the component
|
|
// options (provided as the argument). The returned value has artifical types
|
|
// for TSX / manual render function / IDE support.
|
|
|
|
// overload 1: direct setup function
|
|
// (uses user defined props interface)
|
|
export function defineComponent<Props, RawBindings = object>(
|
|
setup: (
|
|
props: Readonly<Props>,
|
|
ctx: SetupContext
|
|
) => RawBindings | RenderFunction
|
|
): {
|
|
new (): ComponentPublicInstance<
|
|
Props,
|
|
RawBindings,
|
|
{},
|
|
{},
|
|
{},
|
|
// public props
|
|
VNodeProps & Props
|
|
>
|
|
} & FunctionalComponent<Props>
|
|
|
|
// overload 2: object format with no props
|
|
// (uses user defined props interface)
|
|
// return type is for Vetur and TSX support
|
|
export function defineComponent<
|
|
Props = {},
|
|
RawBindings = {},
|
|
D = {},
|
|
C extends ComputedOptions = {},
|
|
M extends MethodOptions = {},
|
|
E extends EmitsOptions = Record<string, any>,
|
|
EE extends string = string
|
|
>(
|
|
options: ComponentOptionsWithoutProps<Props, RawBindings, D, C, M, E, EE>
|
|
): {
|
|
new (): ComponentPublicInstance<
|
|
Props,
|
|
RawBindings,
|
|
D,
|
|
C,
|
|
M,
|
|
E,
|
|
VNodeProps & Props
|
|
>
|
|
} & ComponentOptionsWithoutProps<Props, RawBindings, D, C, M, E, EE>
|
|
|
|
// overload 3: object format with array props declaration
|
|
// props inferred as { [key in PropNames]?: any }
|
|
// return type is for Vetur and TSX support
|
|
export function defineComponent<
|
|
PropNames extends string,
|
|
RawBindings,
|
|
D,
|
|
C extends ComputedOptions = {},
|
|
M extends MethodOptions = {},
|
|
E extends EmitsOptions = Record<string, any>,
|
|
EE extends string = string
|
|
>(
|
|
options: ComponentOptionsWithArrayProps<
|
|
PropNames,
|
|
RawBindings,
|
|
D,
|
|
C,
|
|
M,
|
|
E,
|
|
EE
|
|
>
|
|
): {
|
|
// array props technically doesn't place any contraints on props in TSX
|
|
new (): ComponentPublicInstance<VNodeProps, RawBindings, D, C, M, E>
|
|
} & ComponentOptionsWithArrayProps<PropNames, RawBindings, D, C, M, E, EE>
|
|
|
|
// overload 4: object format with object props declaration
|
|
// see `ExtractPropTypes` in ./componentProps.ts
|
|
export function defineComponent<
|
|
// the Readonly constraint allows TS to treat the type of { required: true }
|
|
// as constant instead of boolean.
|
|
PropsOptions extends Readonly<ComponentPropsOptions>,
|
|
RawBindings,
|
|
D,
|
|
C extends ComputedOptions = {},
|
|
M extends MethodOptions = {},
|
|
E extends EmitsOptions = Record<string, any>,
|
|
EE extends string = string
|
|
>(
|
|
options: ComponentOptionsWithObjectProps<
|
|
PropsOptions,
|
|
RawBindings,
|
|
D,
|
|
C,
|
|
M,
|
|
E,
|
|
EE
|
|
>
|
|
): {
|
|
new (): ComponentPublicInstance<
|
|
ExtractPropTypes<PropsOptions>,
|
|
RawBindings,
|
|
D,
|
|
C,
|
|
M,
|
|
E,
|
|
VNodeProps & ExtractPropTypes<PropsOptions, false>
|
|
>
|
|
} & ComponentOptionsWithObjectProps<PropsOptions, RawBindings, D, C, M, E, EE>
|
|
|
|
// implementation, close to no-op
|
|
export function defineComponent(options: unknown) {
|
|
return isFunction(options) ? { setup: options } : options
|
|
}
|