livereload: Add missing GoDoc - hugo - [fork] hugo port for 9front
HTML git clone git@git.drkhsh.at/hugo.git
DIR Log
DIR Files
DIR Refs
DIR Submodules
DIR README
DIR LICENSE
---
DIR commit 218fceac358ad3c76482ff009be7ccf4df6ce988
DIR parent e467d23374f0e8db0bb7357725a156805bc1d662
HTML Author: Bjørn Erik Pedersen <bjorn.erik.pedersen@gmail.com>
Date: Thu, 24 Mar 2016 14:05:08 +0100
livereload: Add missing GoDoc
Diffstat:
M livereload/livereload.go | 9 ++++++++-
1 file changed, 8 insertions(+), 1 deletion(-)
---
DIR diff --git a/livereload/livereload.go b/livereload/livereload.go
@@ -45,6 +45,8 @@ import (
var upgrader = &websocket.Upgrader{ReadBufferSize: 1024, WriteBufferSize: 1024}
+// Handler is a HandlerFunc handling the livereload
+// Websocket interaction.
func Handler(w http.ResponseWriter, r *http.Request) {
ws, err := upgrader.Upgrade(w, r, nil)
if err != nil {
@@ -57,21 +59,26 @@ func Handler(w http.ResponseWriter, r *http.Request) {
c.reader()
}
+// Initialize starts the Websocket Hub handling live reloads.
func Initialize() {
go wsHub.run()
}
+// ForceRefresh tells livereload to force a hard refresh.
func ForceRefresh() {
- // Tell livereload a js file changed to force a hard refresh
RefreshPath("/x.js")
}
+// RefreshPath tells livereload to refresh only the given path.
+// If that path points to a CSS stylesheet or an image, only the changes
+// will be updated in the browser, not the entire page.
func RefreshPath(s string) {
// Tell livereload a file has changed - will force a hard refresh if not CSS or an image
urlPath := strings.Replace(s, "\\", "/", -1) // If path has backslashes on Windows, make path work for URL
wsHub.broadcast <- []byte(`{"command":"reload","path":"` + urlPath + "\"" + `,"originalPath":"","liveCSS":true,"liveImg":true}`)
}
+// ServeJS serves the liverreload.js who's reference is injected into the page.
func ServeJS(w http.ResponseWriter, r *http.Request) {
w.Header().Set("Content-Type", "application/javascript")
w.Write(livereloadJS)