All skills
vuejs-ai avatar

/vue-options-api-best-practices

@bc922e4 official
by Vue AIvuejs-ai/skills2.9k stars
167

Vue 3 Options API style (data(), methods, this context). Each reference shows Options API solution only.

Use this Skill: https://skilld.dev/gh/vuejs-ai/skills/vue-options-api-best-practices

This session only. Nothing lands on disk.

referencestateful-methods-lifecycle.md

≈481 tokens on demand. Your agent reads this file only when SKILL.md points to it.

Create Stateful Methods in Lifecycle Hooks

Impact: MEDIUM - If you define debounced, throttled, or other stateful functions directly in the methods option, all instances of the component share the same function state. This causes race conditions and bugs in lists of components.

When a component is reused (e.g., in v-for), each instance needs its own debounced/throttled function. Define these in the created() hook and clean them up in unmounted() to prevent memory leaks.

Task Checklist

  • Never define debounced/throttled functions directly in methods
  • Create stateful functions in created() lifecycle hook
  • Always clean up (cancel timers) in unmounted()

Incorrect:

import { debounce } from 'lodash-es'

export default {
  methods: {
    // WRONG: All component instances share this debounced function!
    // If used in a v-for, clicking one button affects all instances
    handleClick: debounce(function() {
      this.performSearch()
    }, 500)
  }
}

Correct:

import { debounce } from 'lodash-es'

export default {
  created() {
    // CORRECT: Each instance gets its own debounced function
    this.debouncedSearch = debounce(this.performSearch, 500)
  },
  unmounted() {
    // CORRECT: Clean up to prevent memory leaks and stale calls
    this.debouncedSearch.cancel()
  },
  methods: {
    handleClick() {
      this.debouncedSearch()
    },
    performSearch() {
      // Actual search logic
    }
  }
}

Reference

Source: SKILL.md on GitHub

No alerts17d5 checks · Risk SAFE
  • Gen Agent Trust Hub17d

    The skill provides comprehensive best practices and TypeScript integration guidelines for the Vue.js Options API. It contains educational content and code examples that are safe and consistent with official Vue.js documentation. No security issues were detected.

  • Socket17d

    No alerts

  • Snyk17d

    Risk: LOW · No issues

  • Runlayer7mo

    11 files scanned · No issues

  • ZeroLeaks5mo

    Score: 93/100 · 2 sections analyzed

Signed by skilld at bc922e4. This ties the file your Agent reads to that commit on GitHub. It does not review the instructions.

Last checked against GitHub 2 months ago.

Steadyupdated 8 months ago
version
2.0.0
author
github.com/vuejs-ai
  • Vue
  • TypeScript
  • options-api
  • lifecycle-hooks
  • type-safety
  • prop-validation
  • computed-properties

README badge

README badge for vuejs-ai/skills/vue-options-api-best-practices

Teaches Vue 3 Options API patterns including TypeScript integration, method binding, and lifecycle hook best practices. Covers type inference for props, event handlers, computed properties, and the this-context gotchas specific to Options API syntax.

Generated from the current SKILL.md.

Does this skill cover Vue 3 Composition API?
No. This skill focuses exclusively on Vue 3 Options API (data(), methods, this context). Composition API patterns are not included.
How does this skill handle TypeScript with Options API?
The skill includes dedicated references for TypeScript integration, such as using defineComponent for type inference, strict mode for this context, and typing complex props, event handlers, computed properties, and provide/inject.
What common mistakes does this skill address?
It covers arrow functions in methods and lifecycle hooks (which break this binding), stateful methods leaking state across component instances, and missing type safety for injected properties.
Can I use this skill if I'm migrating from older Vue versions?
The skill addresses TypeScript compatibility with older versions in the context of prop validators and Options API patterns, but is designed for Vue 3.

Generated from the current SKILL.md. These answers refresh after source changes.