wait-for-update.ts — vue Source File

Architecture documentation for wait-for-update.ts, a typescript file in the vue codebase. 1 imports, 1 dependents.

File typescript VueCore Instance 1 imports 1 dependents 3 functions

Entity Profile

VueCore→ Instance→ wait-for-update.ts — vue Source File

Dependency Diagram

graph LR
  c4611146_2d9c_334d_478d_8cad5a9e4b34["wait-for-update.ts"]
  db9e7bef_009d_3918_6e7d_543a36a38d75["vue"]
  c4611146_2d9c_334d_478d_8cad5a9e4b34 --> db9e7bef_009d_3918_6e7d_543a36a38d75
  0e3275eb_033e_79be_7c0a_56de4c630110["vitest.setup.ts"]
  0e3275eb_033e_79be_7c0a_56de4c630110 --> c4611146_2d9c_334d_478d_8cad5a9e4b34
  style c4611146_2d9c_334d_478d_8cad5a9e4b34 fill:#6366f1,stroke:#818cf8,color:#fff

Relationship Graph

Source Code

import Vue from 'vue'

// helper for async assertions.
// Use like this:
//
// vm.a = 123
// waitForUpdate(() => {
//   expect(vm.$el.textContent).toBe('123')
//   vm.a = 234
// })
// .then(() => {
//   // more assertions...
// })
// .then(done)

interface Job extends Function {
  wait?: boolean
  fail?: (e: any) => void
}

const waitForUpdate = (initialCb: Job) => {
  let end
  const queue: Job[] = initialCb ? [initialCb] : []

  function shift() {
    const job = queue.shift()
    if (queue.length) {
      let hasError = false
      try {
        job!.wait ? job!(shift) : job!()
      } catch (e) {
        hasError = true
        const done = queue[queue.length - 1]
        if (done && done.fail) {
          done.fail(e)
        }
      }
      if (!hasError && !job!.wait) {
        if (queue.length) {
          Vue.nextTick(shift)
        }
      }
    } else if (job && (job.fail || job === end)) {
      job() // done
    }
  }

  Vue.nextTick(() => {
    if (!queue.length || (!end && !queue[queue.length - 1]!.fail)) {
      throw new Error('waitForUpdate chain is missing .then(done)')
    }
    shift()
  })

  const chainer = {
    then: nextCb => {
      queue.push(nextCb)
      return chainer
    },
    thenWaitFor: wait => {
      if (typeof wait === 'number') {
        wait = timeout(wait)
      }
      wait.wait = true
      queue.push(wait)
      return chainer
    },
    end: endFn => {
      queue.push(endFn)
      end = endFn
    }
  }

  return chainer
}

function timeout(n) {
  return next => setTimeout(next, n)
}

export { waitForUpdate }