Getting Started

Installation

Get started with Nuxt WebSocket module.

Quick Setup

Install the module to your Nuxt application with one command:

Terminal

npx nuxi module add nuxt-ws

Ideally you should set your default path, based on where you will place your WebSocket api handlers:

nuxt.config.ts

export default defineNuxtConfig({
  modules: ['nuxt-ws'],

  ws: {
    route: '/_ws', // default undefined
  }
})

Introduction

Some of the key features of Nuxt WebSocket.

Configuration

Configure the Nuxt WebSocket module.