JS.VUE.NO.ASYNC.IN.COMPUTED.PROPERTIES

Disallow asynchronous actions in computed properties

Computed properties and functions should be synchronous. Asynchronous actions inside them may not work as expected and can lead to an unexpected behaviour, that's why you should avoid them. If you need async computed properties you might want to consider using additional plugin [vue-async-computed]

Rule Details

This rule is aimed at preventing asynchronous methods from being called in computed properties and functions.

{'vue/no-async-in-computed-properties': ['error']}

Copy
<script>
export default {
  computed: {
    /* GOOD */
    foo () {
      var bar = 0
      try {
        bar = bar / this.a
      } catch (e) {
        return 0
      } finally {
        return bar
      }
    },

    /* BAD */
    pro () {
      return Promise.all([new Promise((resolve, reject) => {})])
    },
    foo1: async function () {
      return await someFunc()
    },
    bar () {
      return fetch(url).then(response => {})
    },
    tim () {
      setTimeout(() => { }, 0)
    },
    inter () {
      setInterval(() => { }, 0)
    },
    anim () {
      requestAnimationFrame(() => {})
    }
  }
}
</script>

{'vue/no-async-in-computed-properties': ['error']}

Copy
<script>
import {computed} from 'vue'
export default {
  setup() {
    /* GOOD */
    const foo = computed(() => {
      var bar = 0
      try {
        bar = bar / this.a
      } catch (e) {
        return 0
      } finally {
        return bar
      }
    })

    /* BAD */
    const pro = computed(() => Promise.all([new Promise((resolve, reject) => {})]))
    const foo1 = computed(async () => await someFunc())
    const bar = computed(() => {
      return fetch(url).then(response => {})
    })
    const tim = computed(() => {
      setTimeout(() => { }, 0)
    })
    const inter = computed(() => {
      setInterval(() => { }, 0)
    })
    const anim = computed(() => {
      requestAnimationFrame(() => {})
    })
  }
}
</script>

Options

Nothing.

Further Reading

  • vue-async-computed (https://github.com/foxbenjaminfox/vue-async-computed)

The content on this page is adapted from the ESLint User Guide. Copyright © OpenJS Foundation and other contributors, www.openjsf.org. All rights reserved. https://eslint.org/docs/rules/