livereload

Documentation

Overview

Package livereload allows HTML pages to be dynamically reloaded. It includes both the server and client implementations required.

Index

• Constants
• Variables
• type Reloader
• type Server
  • func NewServer(name string, logger termlog.Logger) *Server
  • func (s *Server) Reload(paths []string)
  • func (s *Server) ServeHTTP(w http.ResponseWriter, r *http.Request)
  • func (s *Server) ServeScript(rw http.ResponseWriter, req *http.Request)
  • func (s *Server) Watch(ch chan []string)

Constants

const (

	// EndpointPath is the path to the websocket endpoint
	EndpointPath = "/.devd.livereload"
	// ScriptPath is the path to the livereload JavaScript asset
	ScriptPath = "/.devd.livereload.js"
)

Variables

var Injector = inject.CopyInject{
	Within:      1024 * 30,
	ContentType: "text/html",
	Marker:      regexp.MustCompile(`<\/head>`),
	Payload:     []byte(`<script src="/.devd.livereload.js"></script>`),
}

Injector for the livereload script

Types

type Reloader

type Reloader interface {
	Reload(paths []string)
	Watch(ch chan []string)
}

Reloader triggers a reload

type Server

type Server struct {
	sync.Mutex
	// contains filtered or unexported fields
}

Server implements a Livereload server

func NewServer

func NewServer(name string, logger termlog.Logger) *Server

NewServer createss a Server instance

func (*Server) Reload

func (s *Server) Reload(paths []string)

Reload signals to connected clients that a given resource should be reloaded.

func (*Server) ServeHTTP

func (s *Server) ServeHTTP(w http.ResponseWriter, r *http.Request)

func (*Server) ServeScript

func (s *Server) ServeScript(rw http.ResponseWriter, req *http.Request)

ServeScript is a handler function that serves the livereload JavaScript file

func (*Server) Watch

func (s *Server) Watch(ch chan []string)

Watch montors a channel of lists of paths for reload requests