Skip to content

defineEmits with typescript and union types raises a warning #7943

Closed
@elfjes

Description

@elfjes

Vue version

3.2.47

Link to minimal reproduction

https://sfc.vuejs.org/#eNpNUMtuwkAM/BXLF0CC5J4uqD30L3wJwcDS7ENrh6qi/Hu9SaX2tPbszHg0D3zLublPjB065ZDHXvlAEcAdJ9UU4XUY/fCxJ+Tgdb2SFHi1ITzMMAR27UI0kWv/OTgZis8KwjplGPt4MQ8VU1LUr8zwbn4CeyCsnoTwbWM9QvhCcUhRFOpqlBOffeRZ4B413Jq7Rb/p4J78yQQLSNjHpFcuhFu492MHosXHyx/veVhv7HHtks/S4BZ9yKnoLvS5uUmKVsZ8hn4/LHUHM1Ixa6vuhFfVLF3bynmoFd6kSeXS2tSUKaoP3LCE3bGkT+FixoTV4mkZ8PkDyDyALQ==

Steps to reproduce

click the button that says click me

What is expected?

some event is emitted without warning

What is actually happening?

A warning is raised Component emitted event "some" but it is neither declared in the emits option nor as an "onSome" prop.

System Info

No response

Any additional comments?

The warning is only raised due to the presence of another defined event. If the another event is not defined, the some event is registered properly. ie the following works properly:

type Emits = "some" | "emit";
const emit = defineEmits<{
  (e: Emits): void;
}>();

Activity

LinusBorg

LinusBorg commented on Mar 22, 2023

@LinusBorg
Member

The warning is only raised due to the presence of another defined event. If the another event is not defined, the some event is registered properly. ie the following works properly:

Not exactly. When you remove "another", no event is being registered at all (check the generated JS tab on the right). what however would work currenty, is writing the union inline:

const emit = defineEmits<{
  (e: "some" | "emit"): void;
  (e: "another", val: string): void;
}>();

So this is a current compiler limitation where it does not resolve type aliases used in event names.

elfjes

elfjes commented on Mar 23, 2023

@elfjes
Author

I see, thanks for clearing that up :). I guess for now I'll just live with the warning, or maybe I'll disable it, since I'm importing the Emits type from another module and don't want to duplicate it.

Maybe at some point the compiler will pickup on union types, but no rush. Typescript provides enough safety for me to be comfortable with the current behaviour.

sxzz

sxzz commented on Mar 23, 2023

@sxzz
Member

You can try betterDefine in Vue Macros.

P.S. Sorry I didn't know the issue will be closed via cross-repo commit.

reopened this on Mar 23, 2023
added a commit that references this issue on May 12, 2023
228b687
added a commit that references this issue on May 12, 2023
3711523
added a commit that references this issue on May 18, 2023
b133e0f
locked and limited conversation to collaborators on Sep 10, 2023

1 remaining item

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions

      defineEmits with typescript and union types raises a warning · Issue #7943 · vuejs/core