serve

Documentation

Overview

Package serve implements a local development server with live-reload, similar to VS Code's Live Server extension.

Index

• type Server
  • func New(root, entry string, port int) *Server
  • func (s *Server) Start() error
  • func (s *Server) Stop()
• type Watcher
  • func NewWatcher(root string, callback func(path string)) (*Watcher, error)
  • func (w *Watcher) Close()

Types

type Server

type Server struct {
	Root    string // root directory to serve files from
	Port    int    // port to listen on
	Host    string // host to bind to
	Entry   string // entry HTML file (e.g. "index.html")
	NoOpen  bool   // if true, don't auto-open in browser
	Verbose bool   // print request logs
	// contains filtered or unexported fields
}

Server is a local HTTP file server with live-reload via WebSocket.

func New

func New(root, entry string, port int) *Server

New creates a new Server with sensible defaults.

func (*Server) Start

func (s *Server) Start() error

Start starts the HTTP server and file watcher.

func (*Server) Stop

func (s *Server) Stop()

Stop stops the file watcher and cleans up.

type Watcher

type Watcher struct {
	// contains filtered or unexported fields
}

Watcher watches a directory tree for file changes and calls a callback.

func NewWatcher

func NewWatcher(root string, callback func(path string)) (*Watcher, error)

NewWatcher creates a new file watcher for the given root directory.

func (*Watcher) Close

func (w *Watcher) Close()

Close stops the watcher.