Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Sign up
Appearance settings

Rule suggestion: vue/prefer-single-payload-in-event #2005

Open
@FloEdelmann

Description

Please describe what the rule should do:
When emitting an event, one can pass an event payload. This can consist of multiple parameters. However, when using the always style in the event handler, one can only receive the first event payload parameter.

<my-button @my-event="myHandler($event)" />

See also the vue/v-on-function-call rule and #2001 (comment).

What category should the rule belong to?
[ ] Enforces code style (layout)
[x] Warns about a potential error (problem)
[ ] Suggests an alternate way of doing something (suggestion)
[ ] Other (please specify:)

Provide 2-3 code examples that this rule should warn about:

// BAD:
this.$emit('my-event', foo, bar)
emit('my-event', foo, bar)
defineEmits({ 'my-event': (foo, bar) => true })
defineEmits({ 'my-event': (foo: string, bar: string) => true })
defineEmits<{ (e: 'my-event', foo: string, bar: string): void }>()
{ emits: { 'my-event': (foo, bar) => true } }
{ emits: { 'my-event': (foo: string, bar: string) => true } }
// GOOD:
this.$emit('my-event', foo)
emit('my-event', foo)
defineEmits(['my-event'])
defineEmits({ 'my-event': null })
defineEmits({ 'my-event': (foo) => true })
defineEmits({ 'my-event': (foo: string) => true })
defineEmits<{ (e: 'my-event', foo: string): void }>()
{ emits: ['my-event'] }
{ emits: { 'my-event': null }
{ emits: { 'my-event': (foo) => true } }
{ emits: { 'my-event': (foo: string) => true } }

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

        AltStyle によって変換されたページ (->オリジナル) /