| 123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710171117121713171417151716171717181719172017211722172317241725172617271728172917301731173217331734173517361737173817391740174117421743174417451746174717481749175017511752175317541755175617571758175917601761176217631764176517661767176817691770177117721773177417751776177717781779178017811782178317841785178617871788178917901791179217931794179517961797179817991800180118021803180418051806180718081809181018111812181318141815181618171818181918201821182218231824182518261827182818291830183118321833183418351836183718381839184018411842184318441845184618471848184918501851185218531854185518561857185818591860186118621863186418651866186718681869187018711872187318741875187618771878187918801881188218831884188518861887188818891890189118921893189418951896189718981899190019011902190319041905190619071908190919101911191219131914191519161917191819191920192119221923192419251926192719281929193019311932193319341935193619371938193919401941194219431944194519461947194819491950195119521953195419551956195719581959196019611962196319641965196619671968196919701971197219731974197519761977197819791980198119821983198419851986198719881989199019911992199319941995199619971998199920002001200220032004200520062007200820092010201120122013201420152016201720182019202020212022202320242025202620272028202920302031203220332034203520362037203820392040204120422043204420452046204720482049205020512052205320542055205620572058205920602061206220632064206520662067206820692070207120722073207420752076207720782079208020812082208320842085208620872088208920902091209220932094209520962097209820992100210121022103210421052106210721082109 |
- import {
- type Component,
- type ComponentOptions,
- type ComponentPublicInstance,
- type PropType,
- type SetupContext,
- type Slots,
- type SlotsType,
- type VNode,
- createApp,
- defineComponent,
- h,
- reactive,
- ref,
- withKeys,
- withModifiers,
- } from 'vue'
- import { type IsAny, type IsUnion, describe, expectType } from './utils'
- describe('with object props', () => {
- interface ExpectedProps {
- a?: number | undefined
- aa: number
- aaa: number | null
- aaaa: number | undefined
- b: string
- e?: Function
- h: boolean
- j: undefined | (() => string | undefined)
- bb: string
- bbb: string
- bbbb: string | undefined
- bbbbb: string | undefined
- cc?: string[] | undefined
- dd: { n: 1 }
- ee?: () => string
- ff?: (a: number, b: string) => { a: boolean }
- ccc?: string[] | undefined
- ddd: string[]
- eee: () => { a: string }
- fff: (a: number, b: string) => { a: boolean }
- hhh: boolean
- ggg: 'foo' | 'bar'
- ffff: (a: number, b: string) => { a: boolean }
- iii?: (() => string) | (() => number)
- jjj: ((arg1: string) => string) | ((arg1: string, arg2: string) => string)
- kkk?: any
- validated?: string
- date?: Date
- l?: Date
- ll?: Date | number
- lll?: string | number
- }
- type GT = string & { __brand: unknown }
- const props = {
- a: Number,
- aa: {
- type: Number as PropType<number | undefined>,
- default: 1,
- },
- aaa: {
- type: Number as PropType<number | null>,
- default: 1,
- },
- aaaa: {
- type: Number as PropType<number | undefined>,
- // `as const` prevents widening to `boolean` (keeps literal `true` type)
- required: true as const,
- },
- // required should make property non-void
- b: {
- type: String,
- required: true as true,
- },
- e: Function,
- h: Boolean,
- j: Function as PropType<undefined | (() => string | undefined)>,
- // default value should infer type and make it non-void
- bb: {
- default: 'hello',
- },
- bbb: {
- // Note: default function value requires arrow syntax + explicit
- // annotation
- default: (props: any) => (props.bb as string) || 'foo',
- },
- bbbb: {
- type: String,
- default: undefined,
- },
- bbbbb: {
- type: String,
- default: () => undefined,
- },
- // explicit type casting
- cc: Array as PropType<string[]>,
- // required + type casting
- dd: {
- type: Object as PropType<{ n: 1 }>,
- required: true as true,
- },
- // return type
- ee: Function as PropType<() => string>,
- // arguments + object return
- ff: Function as PropType<(a: number, b: string) => { a: boolean }>,
- // explicit type casting with constructor
- ccc: Array as () => string[],
- // required + constructor type casting
- ddd: {
- type: Array as () => string[],
- required: true as true,
- },
- // required + object return
- eee: {
- type: Function as PropType<() => { a: string }>,
- required: true as true,
- },
- // required + arguments + object return
- fff: {
- type: Function as PropType<(a: number, b: string) => { a: boolean }>,
- required: true as true,
- },
- hhh: {
- type: Boolean,
- required: true as true,
- },
- // default + type casting
- ggg: {
- type: String as PropType<'foo' | 'bar'>,
- default: 'foo',
- },
- // default + function
- ffff: {
- type: Function as PropType<(a: number, b: string) => { a: boolean }>,
- default: (a: number, b: string) => ({ a: a > +b }),
- },
- // union + function with different return types
- iii: Function as PropType<(() => string) | (() => number)>,
- // union + function with different args & same return type
- jjj: {
- type: Function as PropType<
- ((arg1: string) => string) | ((arg1: string, arg2: string) => string)
- >,
- required: true as true,
- },
- kkk: null,
- validated: {
- type: String,
- // validator requires explicit annotation
- validator: (val: unknown) => val !== '',
- },
- date: Date,
- l: [Date],
- ll: [Date, Number],
- lll: [String, Number],
- }
- const MyComponent = defineComponent({
- props,
- setup(props) {
- // type assertion. See https://github.com/SamVerschueren/tsd
- expectType<ExpectedProps['a']>(props.a)
- expectType<ExpectedProps['aa']>(props.aa)
- expectType<ExpectedProps['aaa']>(props.aaa)
- // @ts-expect-error should included `undefined`
- expectType<number>(props.aaaa)
- expectType<ExpectedProps['aaaa']>(props.aaaa)
- expectType<ExpectedProps['b']>(props.b)
- expectType<ExpectedProps['e']>(props.e)
- expectType<ExpectedProps['h']>(props.h)
- expectType<ExpectedProps['j']>(props.j)
- expectType<ExpectedProps['bb']>(props.bb)
- expectType<ExpectedProps['bbb']>(props.bbb)
- expectType<ExpectedProps['bbbb']>(props.bbbb)
- expectType<ExpectedProps['bbbbb']>(props.bbbbb)
- expectType<ExpectedProps['cc']>(props.cc)
- expectType<ExpectedProps['dd']>(props.dd)
- expectType<ExpectedProps['ee']>(props.ee)
- expectType<ExpectedProps['ff']>(props.ff)
- expectType<ExpectedProps['ccc']>(props.ccc)
- expectType<ExpectedProps['ddd']>(props.ddd)
- expectType<ExpectedProps['eee']>(props.eee)
- expectType<ExpectedProps['fff']>(props.fff)
- expectType<ExpectedProps['hhh']>(props.hhh)
- expectType<ExpectedProps['ggg']>(props.ggg)
- expectType<ExpectedProps['ffff']>(props.ffff)
- if (typeof props.iii !== 'function') {
- expectType<undefined>(props.iii)
- }
- expectType<ExpectedProps['iii']>(props.iii)
- expectType<IsUnion<typeof props.jjj>>(true)
- expectType<ExpectedProps['jjj']>(props.jjj)
- expectType<ExpectedProps['kkk']>(props.kkk)
- expectType<ExpectedProps['validated']>(props.validated)
- expectType<ExpectedProps['date']>(props.date)
- expectType<ExpectedProps['l']>(props.l)
- expectType<ExpectedProps['ll']>(props.ll)
- expectType<ExpectedProps['lll']>(props.lll)
- // @ts-expect-error props should be readonly
- props.a = 1
- // setup context
- return {
- c: ref(1),
- d: {
- e: ref('hi'),
- },
- f: reactive({
- g: ref('hello' as GT),
- }),
- }
- },
- provide() {
- return {}
- },
- render() {
- const props = this.$props
- expectType<ExpectedProps['a']>(props.a)
- expectType<ExpectedProps['aa']>(props.aa)
- expectType<ExpectedProps['aaa']>(props.aaa)
- expectType<ExpectedProps['b']>(props.b)
- expectType<ExpectedProps['e']>(props.e)
- expectType<ExpectedProps['h']>(props.h)
- expectType<ExpectedProps['bb']>(props.bb)
- expectType<ExpectedProps['cc']>(props.cc)
- expectType<ExpectedProps['dd']>(props.dd)
- expectType<ExpectedProps['ee']>(props.ee)
- expectType<ExpectedProps['ff']>(props.ff)
- expectType<ExpectedProps['ccc']>(props.ccc)
- expectType<ExpectedProps['ddd']>(props.ddd)
- expectType<ExpectedProps['eee']>(props.eee)
- expectType<ExpectedProps['fff']>(props.fff)
- expectType<ExpectedProps['hhh']>(props.hhh)
- expectType<ExpectedProps['ggg']>(props.ggg)
- if (typeof props.iii !== 'function') {
- expectType<undefined>(props.iii)
- }
- expectType<ExpectedProps['iii']>(props.iii)
- expectType<IsUnion<typeof props.jjj>>(true)
- expectType<ExpectedProps['jjj']>(props.jjj)
- expectType<ExpectedProps['kkk']>(props.kkk)
- // @ts-expect-error props should be readonly
- props.a = 1
- // should also expose declared props on `this`
- expectType<ExpectedProps['a']>(this.a)
- expectType<ExpectedProps['aa']>(this.aa)
- expectType<ExpectedProps['aaa']>(this.aaa)
- expectType<ExpectedProps['b']>(this.b)
- expectType<ExpectedProps['e']>(this.e)
- expectType<ExpectedProps['h']>(this.h)
- expectType<ExpectedProps['bb']>(this.bb)
- expectType<ExpectedProps['cc']>(this.cc)
- expectType<ExpectedProps['dd']>(this.dd)
- expectType<ExpectedProps['ee']>(this.ee)
- expectType<ExpectedProps['ff']>(this.ff)
- expectType<ExpectedProps['ccc']>(this.ccc)
- expectType<ExpectedProps['ddd']>(this.ddd)
- expectType<ExpectedProps['eee']>(this.eee)
- expectType<ExpectedProps['fff']>(this.fff)
- expectType<ExpectedProps['hhh']>(this.hhh)
- expectType<ExpectedProps['ggg']>(this.ggg)
- if (typeof this.iii !== 'function') {
- expectType<undefined>(this.iii)
- }
- expectType<ExpectedProps['iii']>(this.iii)
- const { jjj } = this
- expectType<IsUnion<typeof jjj>>(true)
- expectType<ExpectedProps['jjj']>(this.jjj)
- expectType<ExpectedProps['kkk']>(this.kkk)
- // @ts-expect-error props on `this` should be readonly
- this.a = 1
- // assert setup context unwrapping
- expectType<number>(this.c)
- expectType<string>(this.d.e.value)
- expectType<GT>(this.f.g)
- // setup context properties should be mutable
- this.c = 2
- return null
- },
- })
- expectType<Component>(MyComponent)
- // Test TSX
- expectType<JSX.Element>(
- <MyComponent
- a={1}
- aaaa={1}
- b="b"
- bb="bb"
- e={() => {}}
- cc={['cc']}
- dd={{ n: 1 }}
- ee={() => 'ee'}
- ccc={['ccc']}
- ddd={['ddd']}
- eee={() => ({ a: 'eee' })}
- fff={(a, b) => ({ a: a > +b })}
- hhh={false}
- ggg="foo"
- jjj={() => ''}
- // should allow class/style as attrs
- class="bar"
- style={{ color: 'red' }}
- // should allow key
- key={'foo'}
- // should allow ref
- ref={'foo'}
- ref_for={true}
- />,
- )
- expectType<Component>(
- <MyComponent
- aaaa={1}
- b="b"
- dd={{ n: 1 }}
- ddd={['ddd']}
- eee={() => ({ a: 'eee' })}
- fff={(a, b) => ({ a: a > +b })}
- hhh={false}
- jjj={() => ''}
- />,
- )
- // @ts-expect-error missing required props
- let c = <MyComponent />
- // @ts-expect-error wrong prop types
- c = <MyComponent a={'wrong type'} b="foo" dd={{ n: 1 }} ddd={['foo']} />
- // @ts-expect-error wrong prop types
- c = <MyComponent ggg="baz" />
- // @ts-expect-error
- ;<MyComponent b="foo" dd={{ n: 'string' }} ddd={['foo']} />
- // `this` should be void inside of prop validators and prop default factories
- defineComponent({
- props: {
- myProp: {
- type: Number,
- validator(val: unknown): boolean {
- // @ts-expect-error
- return val !== this.otherProp
- },
- default(): number {
- // @ts-expect-error
- return this.otherProp + 1
- },
- },
- otherProp: {
- type: Number,
- required: true,
- },
- },
- })
- })
- describe('type inference w/ optional props declaration', () => {
- const MyComponent = defineComponent<{ a: string[]; msg: string }>({
- setup(props) {
- expectType<string>(props.msg)
- expectType<string[]>(props.a)
- return {
- b: 1,
- }
- },
- })
- expectType<JSX.Element>(<MyComponent msg="1" a={['1']} />)
- // @ts-expect-error
- ;<MyComponent />
- // @ts-expect-error
- ;<MyComponent msg="1" />
- })
- describe('type inference w/ direct setup function', () => {
- const MyComponent = defineComponent((_props: { msg: string }) => () => {})
- expectType<JSX.Element>(<MyComponent msg="foo" />)
- // @ts-expect-error
- ;<MyComponent />
- // @ts-expect-error
- ;<MyComponent msg={1} />
- })
- describe('type inference w/ array props declaration', () => {
- const MyComponent = defineComponent({
- props: ['a', 'b'],
- setup(props) {
- // @ts-expect-error props should be readonly
- props.a = 1
- expectType<any>(props.a)
- expectType<any>(props.b)
- return {
- c: 1,
- }
- },
- render() {
- expectType<any>(this.$props.a)
- expectType<any>(this.$props.b)
- // @ts-expect-error
- this.$props.a = 1
- expectType<any>(this.a)
- expectType<any>(this.b)
- expectType<number>(this.c)
- },
- })
- expectType<JSX.Element>(<MyComponent a={[1, 2]} b="b" />)
- // @ts-expect-error
- ;<MyComponent other="other" />
- })
- describe('type inference w/ options API', () => {
- defineComponent({
- props: { a: Number },
- setup() {
- return {
- b: 123,
- }
- },
- data() {
- // Limitation: we cannot expose the return result of setup() on `this`
- // here in data() - somehow that would mess up the inference
- expectType<number | undefined>(this.a)
- return {
- c: this.a || 123,
- someRef: ref(0),
- }
- },
- computed: {
- d() {
- expectType<number>(this.b)
- return this.b + 1
- },
- e: {
- get() {
- expectType<number>(this.b)
- expectType<number>(this.d)
- return this.b + this.d
- },
- set(v: number) {
- expectType<number>(this.b)
- expectType<number>(this.d)
- expectType<number>(v)
- },
- },
- },
- watch: {
- a() {
- expectType<number>(this.b)
- this.b + 1
- },
- },
- created() {
- // props
- expectType<number | undefined>(this.a)
- // returned from setup()
- expectType<number>(this.b)
- // returned from data()
- expectType<number>(this.c)
- // computed
- expectType<number>(this.d)
- // computed get/set
- expectType<number>(this.e)
- expectType<number>(this.someRef)
- },
- methods: {
- doSomething() {
- // props
- expectType<number | undefined>(this.a)
- // returned from setup()
- expectType<number>(this.b)
- // returned from data()
- expectType<number>(this.c)
- // computed
- expectType<number>(this.d)
- // computed get/set
- expectType<number>(this.e)
- },
- returnSomething() {
- return this.a
- },
- },
- render() {
- // props
- expectType<number | undefined>(this.a)
- // returned from setup()
- expectType<number>(this.b)
- // returned from data()
- expectType<number>(this.c)
- // computed
- expectType<number>(this.d)
- // computed get/set
- expectType<number>(this.e)
- // method
- expectType<() => number | undefined>(this.returnSomething)
- },
- })
- })
- // #4051
- describe('type inference w/ empty prop object', () => {
- const MyComponent = defineComponent({
- props: {},
- setup(props) {
- return {}
- },
- render() {},
- })
- expectType<JSX.Element>(<MyComponent />)
- // AllowedComponentProps
- expectType<JSX.Element>(<MyComponent class={'foo'} />)
- // ComponentCustomProps
- expectType<JSX.Element>(<MyComponent custom={1} />)
- // VNodeProps
- expectType<JSX.Element>(<MyComponent key="1" />)
- // @ts-expect-error
- expectError(<MyComponent other="other" />)
- })
- describe('with mixins', () => {
- const MixinA = defineComponent({
- emits: ['bar'],
- props: {
- aP1: {
- type: String,
- default: 'aP1',
- },
- aP2: Boolean,
- },
- data() {
- return {
- a: 1,
- }
- },
- })
- const MixinB = defineComponent({
- props: ['bP1', 'bP2'],
- data() {
- return {
- b: 2,
- }
- },
- })
- const MixinC = defineComponent({
- data() {
- return {
- c: 3,
- }
- },
- })
- const MixinD = defineComponent({
- mixins: [MixinA],
- data() {
- //@ts-expect-error computed are not available on data()
- expectError<number>(this.dC1)
- //@ts-expect-error computed are not available on data()
- expectError<string>(this.dC2)
- return {
- d: 4,
- }
- },
- setup(props) {
- expectType<string>(props.aP1)
- },
- computed: {
- dC1() {
- return this.d + this.a
- },
- dC2() {
- return this.aP1 + 'dC2'
- },
- },
- })
- const MyComponent = defineComponent({
- mixins: [MixinA, MixinB, MixinC, MixinD],
- emits: ['click'],
- props: {
- // required should make property non-void
- z: {
- type: String,
- required: true,
- },
- },
- data(vm) {
- expectType<number>(vm.a)
- expectType<number>(vm.b)
- expectType<number>(vm.c)
- expectType<number>(vm.d)
- // should also expose declared props on `this`
- expectType<number>(this.a)
- expectType<string>(this.aP1)
- expectType<boolean | undefined>(this.aP2)
- expectType<number>(this.b)
- expectType<any>(this.bP1)
- expectType<number>(this.c)
- expectType<number>(this.d)
- return {}
- },
- setup(props) {
- expectType<string>(props.z)
- // props
- expectType<((...args: any[]) => any) | undefined>(props.onClick)
- // from MixinA
- expectType<((...args: any[]) => any) | undefined>(props.onBar)
- expectType<string>(props.aP1)
- expectType<boolean | undefined>(props.aP2)
- expectType<any>(props.bP1)
- expectType<any>(props.bP2)
- expectType<string>(props.z)
- },
- render() {
- const props = this.$props
- // props
- expectType<((...args: any[]) => any) | undefined>(props.onClick)
- // from MixinA
- expectType<((...args: any[]) => any) | undefined>(props.onBar)
- expectType<string>(props.aP1)
- expectType<boolean | undefined>(props.aP2)
- expectType<any>(props.bP1)
- expectType<any>(props.bP2)
- expectType<string>(props.z)
- const data = this.$data
- expectType<number>(data.a)
- expectType<number>(data.b)
- expectType<number>(data.c)
- expectType<number>(data.d)
- // should also expose declared props on `this`
- expectType<number>(this.a)
- expectType<string>(this.aP1)
- expectType<boolean | undefined>(this.aP2)
- expectType<number>(this.b)
- expectType<any>(this.bP1)
- expectType<number>(this.c)
- expectType<number>(this.d)
- expectType<number>(this.dC1)
- expectType<string>(this.dC2)
- // props should be readonly
- // @ts-expect-error
- this.aP1 = 'new'
- // @ts-expect-error
- this.z = 1
- // props on `this` should be readonly
- // @ts-expect-error
- this.bP1 = 1
- // string value can not assigned to number type value
- // @ts-expect-error
- this.c = '1'
- // setup context properties should be mutable
- this.d = 5
- return null
- },
- })
- // Test TSX
- expectType<JSX.Element>(
- <MyComponent aP1={'aP'} aP2 bP1={1} bP2={[1, 2]} z={'z'} />,
- )
- // missing required props
- // @ts-expect-error
- ;<MyComponent />
- // wrong prop types
- // @ts-expect-error
- ;<MyComponent aP1="ap" aP2={'wrong type'} bP1="b" z={'z'} />
- // @ts-expect-error
- ;<MyComponent aP1={1} bP2={[1]} />
- })
- describe('with extends', () => {
- const Base = defineComponent({
- props: {
- aP1: Boolean,
- aP2: {
- type: Number,
- default: 2,
- },
- },
- data() {
- return {
- a: 1,
- }
- },
- computed: {
- c(): number {
- return this.aP2 + this.a
- },
- },
- })
- const MyComponent = defineComponent({
- extends: Base,
- props: {
- // required should make property non-void
- z: {
- type: String,
- required: true,
- },
- },
- render() {
- const props = this.$props
- // props
- expectType<boolean | undefined>(props.aP1)
- expectType<number>(props.aP2)
- expectType<string>(props.z)
- const data = this.$data
- expectType<number>(data.a)
- // should also expose declared props on `this`
- expectType<number>(this.a)
- expectType<boolean | undefined>(this.aP1)
- expectType<number>(this.aP2)
- // setup context properties should be mutable
- this.a = 5
- return null
- },
- })
- // Test TSX
- expectType<JSX.Element>(<MyComponent aP2={3} aP1 z={'z'} />)
- // missing required props
- // @ts-expect-error
- ;<MyComponent />
- // wrong prop types
- // @ts-expect-error
- ;<MyComponent aP2={'wrong type'} z={'z'} />
- // @ts-expect-error
- ;<MyComponent aP1={3} />
- })
- describe('extends with mixins', () => {
- const Mixin = defineComponent({
- emits: ['bar'],
- props: {
- mP1: {
- type: String,
- default: 'mP1',
- },
- mP2: Boolean,
- mP3: {
- type: Boolean,
- required: true,
- },
- },
- data() {
- return {
- a: 1,
- }
- },
- })
- const Base = defineComponent({
- emits: ['foo'],
- props: {
- p1: Boolean,
- p2: {
- type: Number,
- default: 2,
- },
- p3: {
- type: Boolean,
- required: true,
- },
- },
- data() {
- return {
- b: 2,
- }
- },
- computed: {
- c(): number {
- return this.p2 + this.b
- },
- },
- })
- const MyComponent = defineComponent({
- extends: Base,
- mixins: [Mixin],
- emits: ['click'],
- props: {
- // required should make property non-void
- z: {
- type: String,
- required: true,
- },
- },
- render() {
- const props = this.$props
- // props
- expectType<((...args: any[]) => any) | undefined>(props.onClick)
- // from Mixin
- expectType<((...args: any[]) => any) | undefined>(props.onBar)
- // from Base
- expectType<((...args: any[]) => any) | undefined>(props.onFoo)
- expectType<boolean | undefined>(props.p1)
- expectType<number>(props.p2)
- expectType<string>(props.z)
- expectType<string>(props.mP1)
- expectType<boolean | undefined>(props.mP2)
- const data = this.$data
- expectType<number>(data.a)
- expectType<number>(data.b)
- // should also expose declared props on `this`
- expectType<number>(this.a)
- expectType<number>(this.b)
- expectType<boolean | undefined>(this.p1)
- expectType<number>(this.p2)
- expectType<string>(this.mP1)
- expectType<boolean | undefined>(this.mP2)
- // setup context properties should be mutable
- this.a = 5
- return null
- },
- })
- // Test TSX
- expectType<JSX.Element>(<MyComponent mP1="p1" mP2 mP3 p1 p2={1} p3 z={'z'} />)
- // mP1, mP2, p1, and p2 have default value. these are not required
- expectType<JSX.Element>(<MyComponent mP3 p3 z={'z'} />)
- // missing required props
- // @ts-expect-error
- ;<MyComponent mP3 p3 /* z='z' */ />
- // missing required props from mixin
- // @ts-expect-error
- ;<MyComponent /* mP3 */ p3 z="z" />
- // missing required props from extends
- // @ts-expect-error
- ;<MyComponent mP3 /* p3 */ z="z" />
- // wrong prop types
- // @ts-expect-error
- ;<MyComponent p2={'wrong type'} z={'z'} />
- // @ts-expect-error
- ;<MyComponent mP1={3} />
- // #3468
- const CompWithD = defineComponent({
- data() {
- return { foo: 1 }
- },
- })
- const CompWithC = defineComponent({
- computed: {
- foo() {
- return 1
- },
- },
- })
- const CompWithM = defineComponent({ methods: { foo() {} } })
- const CompEmpty = defineComponent({})
- defineComponent({
- mixins: [CompWithD, CompEmpty],
- mounted() {
- expectType<number>(this.foo)
- },
- })
- defineComponent({
- mixins: [CompWithC, CompEmpty],
- mounted() {
- expectType<number>(this.foo)
- },
- })
- defineComponent({
- mixins: [CompWithM, CompEmpty],
- mounted() {
- expectType<() => void>(this.foo)
- },
- })
- })
- describe('compatibility w/ createApp', () => {
- const comp = defineComponent({})
- createApp(comp).mount('#hello')
- const comp2 = defineComponent({
- props: { foo: String },
- })
- createApp(comp2).mount('#hello')
- const comp3 = defineComponent({
- setup() {
- return {
- a: 1,
- }
- },
- })
- createApp(comp3).mount('#hello')
- })
- describe('defineComponent', () => {
- describe('should accept components defined with defineComponent', () => {
- const comp = defineComponent({})
- defineComponent({
- components: { comp },
- })
- })
- describe('should accept class components with receiving constructor arguments', () => {
- class Comp {
- static __vccOpts = {}
- constructor(_props: { foo: string }) {}
- }
- defineComponent({
- components: { Comp },
- })
- })
- })
- describe('emits', () => {
- // Note: for TSX inference, ideally we want to map emits to onXXX props,
- // but that requires type-level string constant concatenation as suggested in
- // https://github.com/Microsoft/TypeScript/issues/12754
- // The workaround for TSX users is instead of using emits, declare onXXX props
- // and call them instead. Since `v-on:click` compiles to an `onClick` prop,
- // this would also support other users consuming the component in templates
- // with `v-on` listeners.
- // with object emits
- defineComponent({
- emits: {
- click: (n: number) => typeof n === 'number',
- input: (b: string) => b.length > 1,
- Focus: (f: boolean) => !!f,
- },
- setup(props, { emit }) {
- expectType<((n: number) => boolean) | undefined>(props.onClick)
- expectType<((b: string) => boolean) | undefined>(props.onInput)
- expectType<((f: boolean) => boolean) | undefined>(props.onFocus)
- emit('click', 1)
- emit('input', 'foo')
- emit('Focus', true)
- // @ts-expect-error
- emit('nope')
- // @ts-expect-error
- emit('click')
- // @ts-expect-error
- emit('click', 'foo')
- // @ts-expect-error
- emit('input')
- // @ts-expect-error
- emit('input', 1)
- // @ts-expect-error
- emit('focus')
- // @ts-expect-error
- emit('focus', true)
- },
- created() {
- this.$emit('click', 1)
- this.$emit('input', 'foo')
- // @ts-expect-error
- this.$emit('nope')
- // @ts-expect-error
- this.$emit('click')
- // @ts-expect-error
- this.$emit('click', 'foo')
- // @ts-expect-error
- this.$emit('input')
- // @ts-expect-error
- this.$emit('input', 1)
- // @ts-expect-error
- this.$emit('focus')
- // @ts-expect-error
- this.$emit('focus', true)
- },
- mounted() {
- // #3599
- this.$nextTick(function () {
- // this should be bound to this instance
- this.$emit('click', 1)
- this.$emit('input', 'foo')
- // @ts-expect-error
- this.$emit('nope')
- // @ts-expect-error
- this.$emit('click')
- // @ts-expect-error
- this.$emit('click', 'foo')
- // @ts-expect-error
- this.$emit('input')
- // @ts-expect-error
- this.$emit('input', 1)
- // @ts-expect-error
- this.$emit('focus')
- // @ts-expect-error
- this.$emit('focus', true)
- })
- },
- })
- // with array emits
- defineComponent({
- emits: ['foo', 'bar'],
- setup(props, { emit }) {
- expectType<((...args: any[]) => any) | undefined>(props.onFoo)
- expectType<((...args: any[]) => any) | undefined>(props.onBar)
- emit('foo')
- emit('foo', 123)
- emit('bar')
- // @ts-expect-error
- emit('nope')
- },
- created() {
- this.$emit('foo')
- this.$emit('foo', 123)
- this.$emit('bar')
- // @ts-expect-error
- this.$emit('nope')
- },
- })
- // with tsx
- const Component = defineComponent({
- emits: {
- click: (n: number) => typeof n === 'number',
- },
- setup(props, { emit }) {
- expectType<((n: number) => any) | undefined>(props.onClick)
- emit('click', 1)
- // @ts-expect-error
- emit('click')
- // @ts-expect-error
- emit('click', 'foo')
- },
- })
- defineComponent({
- render() {
- return (
- <Component
- onClick={(n: number) => {
- return n + 1
- }}
- />
- )
- },
- })
- // #11803 manual props annotation in setup()
- const Hello = defineComponent({
- name: 'HelloWorld',
- inheritAttrs: false,
- props: { foo: String },
- emits: {
- customClick: (args: string) => typeof args === 'string',
- },
- setup(props: { foo?: string }) {},
- })
- ;<Hello onCustomClick={() => {}} />
- // without emits
- defineComponent({
- setup(props, { emit }) {
- emit('test', 1)
- emit('test')
- },
- })
- // emit should be valid when ComponentPublicInstance is used.
- const instance = {} as ComponentPublicInstance
- instance.$emit('test', 1)
- instance.$emit('test')
- // `this` should be void inside of emits validators
- defineComponent({
- props: ['bar'],
- emits: {
- foo(): boolean {
- // @ts-expect-error
- return this.bar === 3
- },
- },
- })
- })
- describe('inject', () => {
- // with object inject
- defineComponent({
- props: {
- a: String,
- },
- inject: {
- foo: 'foo',
- bar: 'bar',
- },
- created() {
- expectType<unknown>(this.foo)
- expectType<unknown>(this.bar)
- // @ts-expect-error
- this.foobar = 1
- },
- })
- // with array inject
- defineComponent({
- props: ['a', 'b'],
- inject: ['foo', 'bar'],
- created() {
- expectType<unknown>(this.foo)
- expectType<unknown>(this.bar)
- // @ts-expect-error
- this.foobar = 1
- },
- })
- // with no props
- defineComponent({
- inject: {
- foo: {
- from: 'pfoo',
- default: 'foo',
- },
- bar: {
- from: 'pbar',
- default: 'bar',
- },
- },
- created() {
- expectType<unknown>(this.foo)
- expectType<unknown>(this.bar)
- // @ts-expect-error
- this.foobar = 1
- },
- })
- // without inject
- defineComponent({
- props: ['a', 'b'],
- created() {
- // @ts-expect-error
- this.foo = 1
- // @ts-expect-error
- this.bar = 1
- },
- })
- })
- describe('componentOptions setup should be `SetupContext`', () => {
- expectType<ComponentOptions['setup']>(
- {} as (props: Record<string, any>, ctx: SetupContext) => any,
- )
- })
- describe('extract instance type', () => {
- const Base = defineComponent({
- props: {
- baseA: {
- type: Number,
- default: 1,
- },
- },
- })
- const MixinA = defineComponent({
- props: {
- mA: {
- type: String,
- default: '',
- },
- },
- })
- const CompA = defineComponent({
- extends: Base,
- mixins: [MixinA],
- props: {
- a: {
- type: Boolean,
- default: false,
- },
- b: {
- type: String,
- required: true,
- },
- c: Number,
- },
- })
- const compA = {} as InstanceType<typeof CompA>
- expectType<boolean>(compA.a)
- expectType<string>(compA.b)
- expectType<number | undefined>(compA.c)
- // mixins
- expectType<string>(compA.mA)
- // extends
- expectType<number>(compA.baseA)
- // @ts-expect-error
- compA.a = true
- // @ts-expect-error
- compA.b = 'foo'
- // @ts-expect-error
- compA.c = 1
- // @ts-expect-error
- compA.mA = 'foo'
- // @ts-expect-error
- compA.baseA = 1
- })
- describe('async setup', () => {
- type GT = string & { __brand: unknown }
- const Comp = defineComponent({
- async setup() {
- // setup context
- return {
- a: ref(1),
- b: {
- c: ref('hi'),
- },
- d: reactive({
- e: ref('hello' as GT),
- }),
- }
- },
- render() {
- // assert setup context unwrapping
- expectType<number>(this.a)
- expectType<string>(this.b.c.value)
- expectType<GT>(this.d.e)
- // setup context properties should be mutable
- this.a = 2
- },
- })
- const vm = {} as InstanceType<typeof Comp>
- // assert setup context unwrapping
- expectType<number>(vm.a)
- expectType<string>(vm.b.c.value)
- expectType<GT>(vm.d.e)
- // setup context properties should be mutable
- vm.a = 2
- })
- // #5948
- describe('DefineComponent should infer correct types when assigning to Component', () => {
- let component: Component
- component = defineComponent({
- setup(_, { attrs, slots }) {
- // @ts-expect-error should not be any
- expectType<[]>(attrs)
- // @ts-expect-error should not be any
- expectType<[]>(slots)
- },
- })
- expectType<Component>(component)
- })
- // #5969
- describe('should allow to assign props', () => {
- const Child = defineComponent({
- props: {
- bar: String,
- },
- })
- const Parent = defineComponent({
- props: {
- ...Child.props,
- foo: String,
- },
- })
- const child = new Child()
- expectType<JSX.Element>(<Parent {...child.$props} />)
- })
- // #6052
- describe('prop starting with `on*` is broken', () => {
- defineComponent({
- props: {
- onX: {
- type: Function as PropType<(a: 1) => void>,
- required: true,
- },
- },
- setup(props) {
- expectType<(a: 1) => void>(props.onX)
- props.onX(1)
- },
- })
- defineComponent({
- props: {
- onX: {
- type: Function as PropType<(a: 1) => void>,
- required: true,
- },
- },
- emits: {
- test: (a: 1) => true,
- },
- setup(props) {
- expectType<(a: 1) => void>(props.onX)
- expectType<undefined | ((a: 1) => any)>(props.onTest)
- },
- })
- })
- describe('function syntax w/ generics', () => {
- const Comp = defineComponent(
- // TODO: babel plugin to auto infer runtime props options from type
- // similar to defineProps<{...}>()
- <T extends string | number>(props: { msg: T; list: T[] }) => {
- // use Composition API here like in <script setup>
- const count = ref(0)
- return () => (
- // return a render function (both JSX and h() works)
- <div>
- {props.msg} {count.value}
- </div>
- )
- },
- )
- expectType<JSX.Element>(<Comp msg="fse" list={['foo']} />)
- expectType<JSX.Element>(<Comp msg={123} list={[123]} />)
- expectType<JSX.Element>(
- // @ts-expect-error missing prop
- <Comp msg={123} />,
- )
- expectType<JSX.Element>(
- // @ts-expect-error generics don't match
- <Comp msg="fse" list={[123]} />,
- )
- expectType<JSX.Element>(
- // @ts-expect-error generics don't match
- <Comp msg={123} list={['123']} />,
- )
- })
- describe('function syntax w/ emits', () => {
- const Foo = defineComponent(
- (props: { msg: string }, ctx) => {
- ctx.emit('foo')
- // @ts-expect-error
- ctx.emit('bar')
- return () => {}
- },
- {
- emits: ['foo'],
- },
- )
- expectType<JSX.Element>(<Foo msg="hi" onFoo={() => {}} />)
- // @ts-expect-error
- expectType<JSX.Element>(<Foo msg="hi" onBar={() => {}} />)
- defineComponent(
- (props: { msg: string }, ctx) => {
- ctx.emit('foo', 'hi')
- // @ts-expect-error
- ctx.emit('foo')
- // @ts-expect-error
- ctx.emit('bar')
- return () => {}
- },
- {
- emits: {
- foo: (a: string) => true,
- },
- },
- )
- })
- describe('function syntax w/ runtime props', () => {
- // with runtime props, the runtime props must match
- // manual type declaration
- defineComponent(
- (_props: { msg: string }) => {
- return () => {}
- },
- {
- props: ['msg'],
- },
- )
- defineComponent(
- <T extends string>(_props: { msg: T }) => {
- return () => {}
- },
- {
- props: ['msg'],
- },
- )
- defineComponent(
- <T extends string>(_props: { msg: T }) => {
- return () => {}
- },
- {
- props: {
- msg: String,
- },
- },
- )
- // @ts-expect-error string prop names don't match
- defineComponent(
- (_props: { msg: string }) => {
- return () => {}
- },
- {
- props: ['bar'],
- },
- )
- defineComponent(
- (_props: { msg: string }) => {
- return () => {}
- },
- {
- props: {
- // @ts-expect-error prop type mismatch
- msg: Number,
- },
- },
- )
- // @ts-expect-error prop keys don't match
- defineComponent(
- (_props: { msg: string }, ctx) => {
- return () => {}
- },
- {
- props: {
- msg: String,
- bar: String,
- },
- },
- )
- })
- // check if defineComponent can be exported
- export default {
- // function components
- a: defineComponent(_ => () => h('div')),
- // no props
- b: defineComponent({
- data() {
- return {}
- },
- }),
- c: defineComponent({
- props: ['a'],
- }),
- d: defineComponent({
- props: {
- a: Number,
- },
- }),
- }
- describe('slots', () => {
- const comp1 = defineComponent({
- slots: Object as SlotsType<{
- default: { foo: string; bar: number }
- optional?: { data: string }
- undefinedScope: undefined | { data: string }
- optionalUndefinedScope?: undefined | { data: string }
- }>,
- setup(props, { slots }) {
- expectType<(scope: { foo: string; bar: number }) => VNode[]>(
- slots.default,
- )
- expectType<((scope: { data: string }) => VNode[]) | undefined>(
- slots.optional,
- )
- slots.default({ foo: 'foo', bar: 1 })
- // @ts-expect-error it's optional
- slots.optional({ data: 'foo' })
- slots.optional?.({ data: 'foo' })
- expectType<{
- (): VNode[]
- (scope: undefined | { data: string }): VNode[]
- }>(slots.undefinedScope)
- expectType<
- | { (): VNode[]; (scope: undefined | { data: string }): VNode[] }
- | undefined
- >(slots.optionalUndefinedScope)
- slots.default({ foo: 'foo', bar: 1 })
- // @ts-expect-error it's optional
- slots.optional({ data: 'foo' })
- slots.optional?.({ data: 'foo' })
- slots.undefinedScope()
- slots.undefinedScope(undefined)
- // @ts-expect-error
- slots.undefinedScope('foo')
- slots.optionalUndefinedScope?.()
- slots.optionalUndefinedScope?.(undefined)
- slots.optionalUndefinedScope?.({ data: 'foo' })
- // @ts-expect-error
- slots.optionalUndefinedScope()
- // @ts-expect-error
- slots.optionalUndefinedScope?.('foo')
- expectType<typeof slots | undefined>(new comp1().$slots)
- },
- })
- const comp2 = defineComponent({
- setup(props, { slots }) {
- // unknown slots
- expectType<Slots>(slots)
- expectType<((...args: any[]) => VNode[]) | undefined>(slots.default)
- },
- })
- expectType<Slots | undefined>(new comp2().$slots)
- })
- // #5885
- describe('should work when props type is incompatible with setup returned type ', () => {
- type SizeType = 'small' | 'big'
- const Comp = defineComponent({
- props: {
- size: {
- type: String as PropType<SizeType>,
- required: true,
- },
- },
- setup(props) {
- expectType<SizeType>(props.size)
- return {
- size: 1,
- }
- },
- })
- type CompInstance = InstanceType<typeof Comp>
- const CompA = {} as CompInstance
- expectType<ComponentPublicInstance>(CompA)
- expectType<number>(CompA.size)
- expectType<SizeType>(CompA.$props.size)
- })
- describe('withKeys and withModifiers as pro', () => {
- const onKeydown = withKeys(e => {}, [''])
- const onClick = withModifiers(e => {}, [])
- ;<input onKeydown={onKeydown} onClick={onClick} />
- })
- // #3367 expose components types
- describe('expose component types', () => {
- const child = defineComponent({
- props: {
- a: String,
- },
- })
- const parent = defineComponent({
- components: {
- child,
- child2: {
- template: `<div></div>`,
- },
- },
- })
- expectType<typeof child>(parent.components!.child)
- expectType<Component>(parent.components!.child2)
- // global components
- expectType<Readonly<KeepAliveProps>>(
- new parent.components!.KeepAlive().$props,
- )
- expectType<Readonly<KeepAliveProps>>(new child.components!.KeepAlive().$props)
- // runtime-dom components
- expectType<Readonly<TransitionProps>>(
- new parent.components!.Transition().$props,
- )
- expectType<Readonly<TransitionProps>>(
- new child.components!.Transition().$props,
- )
- })
- describe('directive typing', () => {
- const customDirective: Directive = {
- created(_) {},
- }
- const comp = defineComponent({
- props: {
- a: String,
- },
- directives: {
- customDirective,
- localDirective: {
- created(_, { arg }) {
- expectType<string | undefined>(arg)
- },
- },
- },
- })
- expectType<typeof customDirective>(comp.directives!.customDirective)
- expectType<Directive>(comp.directives!.localDirective)
- // global directive
- expectType<typeof vShow>(comp.directives!.vShow)
- })
- describe('expose typing', () => {
- const Comp = defineComponent({
- expose: ['a', 'b'],
- props: {
- some: String,
- },
- data() {
- return { a: 1, b: '2', c: 1 }
- },
- })
- expectType<Array<'a' | 'b'>>(Comp.expose!)
- const vm = new Comp()
- // internal should still be exposed
- vm.$props
- expectType<number>(vm.a)
- expectType<string>(vm.b)
- // @ts-expect-error shouldn't be exposed
- vm.c
- })
- import type {
- AllowedComponentProps,
- ComponentCustomProps,
- ComponentInstance,
- ComponentOptionsMixin,
- DefineComponent,
- Directive,
- EmitsOptions,
- ExtractPropTypes,
- KeepAliveProps,
- TransitionProps,
- VNodeProps,
- vShow,
- } from 'vue'
- // code generated by tsc / vue-tsc, make sure this continues to work
- // so we don't accidentally change the args order of DefineComponent
- declare const MyButton: DefineComponent<
- {},
- () => JSX.Element,
- {},
- {},
- {},
- ComponentOptionsMixin,
- ComponentOptionsMixin,
- EmitsOptions,
- string,
- VNodeProps & AllowedComponentProps & ComponentCustomProps,
- Readonly<ExtractPropTypes<{}>>,
- {},
- {}
- >
- ;<MyButton class="x" />
- describe('__typeProps backdoor for union type for conditional props', () => {
- interface CommonProps {
- size?: 'xl' | 'l' | 'm' | 's' | 'xs'
- }
- type ConditionalProps =
- | {
- color?: 'normal' | 'primary' | 'secondary'
- appearance?: 'normal' | 'outline' | 'text'
- }
- | {
- color: 'white'
- appearance: 'outline'
- }
- type Props = CommonProps & ConditionalProps
- const Comp = defineComponent({
- __typeProps: {} as Props,
- })
- // @ts-expect-error
- ;<Comp color="white" />
- // @ts-expect-error
- ;<Comp color="white" appearance="normal" />
- ;<Comp color="white" appearance="outline" />
- const c = new Comp()
- // @ts-expect-error
- c.$props = { color: 'white' }
- // @ts-expect-error
- c.$props = { color: 'white', appearance: 'text' }
- c.$props = { color: 'white', appearance: 'outline' }
- })
- describe('__typeEmits backdoor, 3.3+ object syntax', () => {
- type Emits = {
- change: [id: number]
- update: [value: string]
- }
- const Comp = defineComponent({
- __typeEmits: {} as Emits,
- mounted() {
- this.$props.onChange?.(123)
- // @ts-expect-error
- this.$props.onChange?.('123')
- this.$props.onUpdate?.('foo')
- // @ts-expect-error
- this.$props.onUpdate?.(123)
- // @ts-expect-error
- this.$emit('foo')
- this.$emit('change', 123)
- // @ts-expect-error
- this.$emit('change', '123')
- this.$emit('update', 'test')
- // @ts-expect-error
- this.$emit('update', 123)
- },
- })
- ;<Comp onChange={id => id.toFixed(2)} />
- ;<Comp onUpdate={id => id.toUpperCase()} />
- // @ts-expect-error
- ;<Comp onChange={id => id.slice(1)} />
- // @ts-expect-error
- ;<Comp onUpdate={id => id.toFixed(2)} />
- const c = new Comp()
- // @ts-expect-error
- c.$emit('foo')
- c.$emit('change', 123)
- // @ts-expect-error
- c.$emit('change', '123')
- c.$emit('update', 'test')
- // @ts-expect-error
- c.$emit('update', 123)
- })
- describe('__typeEmits backdoor, call signature syntax', () => {
- type Emits = {
- (e: 'change', id: number): void
- (e: 'update', value: string): void
- }
- const Comp = defineComponent({
- __typeEmits: {} as Emits,
- mounted() {
- this.$props.onChange?.(123)
- // @ts-expect-error
- this.$props.onChange?.('123')
- this.$props.onUpdate?.('foo')
- // @ts-expect-error
- this.$props.onUpdate?.(123)
- // @ts-expect-error
- this.$emit('foo')
- this.$emit('change', 123)
- // @ts-expect-error
- this.$emit('change', '123')
- this.$emit('update', 'test')
- // @ts-expect-error
- this.$emit('update', 123)
- },
- })
- ;<Comp onChange={id => id.toFixed(2)} />
- ;<Comp onUpdate={id => id.toUpperCase()} />
- // @ts-expect-error
- ;<Comp onChange={id => id.slice(1)} />
- // @ts-expect-error
- ;<Comp onUpdate={id => id.toFixed(2)} />
- const c = new Comp()
- // @ts-expect-error
- c.$emit('foo')
- c.$emit('change', 123)
- // @ts-expect-error
- c.$emit('change', '123')
- c.$emit('update', 'test')
- // @ts-expect-error
- c.$emit('update', 123)
- })
- describe('__typeRefs backdoor, object syntax', () => {
- type Refs = {
- foo: number
- }
- const Parent = defineComponent({
- __typeRefs: {} as { child: ComponentInstance<typeof Child> },
- })
- const Child = defineComponent({
- __typeRefs: {} as Refs,
- })
- const c = new Parent()
- const refs = c.$refs
- expectType<ComponentInstance<typeof Child>>(refs.child)
- expectType<number>(refs.child.$refs.foo)
- })
- describe('__typeEl backdoor', () => {
- const Comp = defineComponent({
- __typeEl: {} as HTMLAnchorElement,
- })
- const c = new Comp()
- expectType<HTMLAnchorElement>(c.$el)
- })
- defineComponent({
- props: {
- foo: [String, null],
- },
- setup(props) {
- expectType<IsAny<typeof props.foo>>(false)
- expectType<string | null | undefined>(props.foo)
- },
- })
- import type * as vue from 'vue'
- interface ErrorMessageSlotProps {
- message: string | undefined
- }
- /**
- * #10842
- * component types generated by vue-tsc
- * relying on legacy CreateComponentPublicInstance signature
- */
- declare const ErrorMessage: {
- new (...args: any[]): vue.CreateComponentPublicInstance<
- Readonly<
- vue.ExtractPropTypes<{
- as: {
- type: StringConstructor
- default: any
- }
- name: {
- type: StringConstructor
- required: true
- }
- }>
- >,
- () =>
- | VNode<
- vue.RendererNode,
- vue.RendererElement,
- {
- [key: string]: any
- }
- >
- | vue.Slot<any>
- | VNode<
- vue.RendererNode,
- vue.RendererElement,
- {
- [key: string]: any
- }
- >[]
- | {
- default: () => VNode<
- vue.RendererNode,
- vue.RendererElement,
- {
- [key: string]: any
- }
- >[]
- },
- unknown,
- {},
- {},
- vue.ComponentOptionsMixin,
- vue.ComponentOptionsMixin,
- {},
- vue.VNodeProps &
- vue.AllowedComponentProps &
- vue.ComponentCustomProps &
- Readonly<
- vue.ExtractPropTypes<{
- as: {
- type: StringConstructor
- default: any
- }
- name: {
- type: StringConstructor
- required: true
- }
- }>
- >,
- {
- as: string
- },
- true,
- {},
- {},
- {
- P: {}
- B: {}
- D: {}
- C: {}
- M: {}
- Defaults: {}
- },
- Readonly<
- vue.ExtractPropTypes<{
- as: {
- type: StringConstructor
- default: any
- }
- name: {
- type: StringConstructor
- required: true
- }
- }>
- >,
- () =>
- | VNode<
- vue.RendererNode,
- vue.RendererElement,
- {
- [key: string]: any
- }
- >
- | vue.Slot<any>
- | VNode<
- vue.RendererNode,
- vue.RendererElement,
- {
- [key: string]: any
- }
- >[]
- | {
- default: () => VNode<
- vue.RendererNode,
- vue.RendererElement,
- {
- [key: string]: any
- }
- >[]
- },
- {},
- {},
- {},
- {
- as: string
- }
- >
- __isFragment?: never
- __isTeleport?: never
- __isSuspense?: never
- } & vue.ComponentOptionsBase<
- Readonly<
- vue.ExtractPropTypes<{
- as: {
- type: StringConstructor
- default: any
- }
- name: {
- type: StringConstructor
- required: true
- }
- }>
- >,
- () =>
- | VNode<
- vue.RendererNode,
- vue.RendererElement,
- {
- [key: string]: any
- }
- >
- | vue.Slot<any>
- | VNode<
- vue.RendererNode,
- vue.RendererElement,
- {
- [key: string]: any
- }
- >[]
- | {
- default: () => VNode<
- vue.RendererNode,
- vue.RendererElement,
- {
- [key: string]: any
- }
- >[]
- },
- unknown,
- {},
- {},
- vue.ComponentOptionsMixin,
- vue.ComponentOptionsMixin,
- {},
- string,
- {
- as: string
- },
- {},
- string,
- {}
- > &
- vue.VNodeProps &
- vue.AllowedComponentProps &
- vue.ComponentCustomProps &
- (new () => {
- $slots: {
- default: (arg: ErrorMessageSlotProps) => VNode[]
- }
- })
- ;<ErrorMessage name="password" class="error" />
- // #10843
- createApp({}).component(
- 'SomeComponent',
- defineComponent({
- props: {
- title: String,
- },
- setup(props) {
- expectType<string | undefined>(props.title)
- return {}
- },
- }),
- )
- const Comp = defineComponent({
- props: {
- actionText: {
- type: {} as PropType<string>,
- default: 'Become a sponsor',
- },
- },
- __typeProps: {} as {
- actionText?: string
- },
- })
- const instance = new Comp()
- function expectString(s: string) {}
- // instance prop with default should be non-null
- expectString(instance.actionText)
- // public prop on $props should be optional
- // @ts-expect-error
- expectString(instance.$props.actionText)
- // #12122
- defineComponent({
- props: { foo: String },
- render() {
- expectType<{ readonly foo?: string }>(this.$props)
- // @ts-expect-error
- expectType<string>(this.$props)
- },
- })
|