nuxt-dev-ready

v3.0.0
Waits until the Nuxt dev server is loaded. Mainly useful for testing.
wait

nuxt-dev-ready

npm version Linux macOS Windows compatible Build status Coverage status Dependency status Renovate enabled
Open in Gitpod Buy Me a Coffee PayPal Patreon

Waits until the Nuxt dev server is loaded. Mainly useful for testing.

Install

# npm
$ npm install nuxt-dev-ready

# Yarn
$ yarn add nuxt-dev-ready

Usage

import { execaCommand } from 'execa'
import kill from 'tree-kill-promise'
import nuxtDevReady from 'nuxt-dev-ready'

const nuxt = execaCommand('nuxt dev')

try {
  await nuxtDevReady()

  // Do some testing
} finally {
  await kill(nuxt.pid)
} 

Custom port

You can pass a custom port to nuxtDevReady like so:

import { execaCommand } from 'execa'
import kill from 'tree-kill-promise'
import nuxtDevReady from 'nuxt-dev-ready'

const nuxt = execaCommand('nuxt dev', { env: { PORT: 4000 } })

try {
  await nuxtDevReady(4000)
} finally {
  await kill(nuxt.pid)
} 

Contribute

Are you missing something or want to contribute? Feel free to file an issue or a pull request! ⚙️

Support

Hey, I am Sebastian Landwehr, a freelance web developer, and I love developing web apps and open source packages. If you want to support me so that I can keep packages up to date and build more helpful tools, you can donate here:

Buy Me a Coffee  If you want to send me a one time donation. The coffee is pretty good 😊.
PayPal  Also for one time donations if you like PayPal.
Patreon  Here you can support me regularly, which is great so I can steadily work on projects.

Thanks a lot for your support! ❤️

License

MIT License © Sebastian Landwehr

npm i nuxt-dev-ready

Metadata

  • MIT
  • >=18
  • Sebastian Landwehr
  • released 1/24/2024

Downloads

Maintainers