README
¶
Humble/detect
Detect is a tiny go package for detecting whether code is running on the server or browser. It is intended to be used with hybrid go applications and gopherjs. Detect works great as a stand-alone package or in combination with other Humble packages.
Detect is written in pure go. It feels like go, follows go idioms when possible, and compiles with the go tools. Detect runs on the server and can also be compiled to javascript and run in the browser.
Browser Support
Detect works with IE9+ (with a polyfill for typed arrays) and all other modern browsers. Detect compiles to javascript via gopherjs and this is a gopherjs limitation.
Installation
Install detect like you would any other go package:
go get github.com/go-humble/detect
You will also need to install gopherjs if you don't already have it. The latest version is recommended. Install gopherjs with:
go get -u github.com/gopherjs/gopherjs
You can compile your application to javascript using the gopherjs build command. Run
gopherjs --help to learn more about the gopherjs command-line tool.
Example Usage
Detect is intended to be used in hybrid go applications which use gopherjs to compile to javascript. When you are sharing code between the server and browser, it is often useful to be able to quickly detect which platform the code is currently running on. For example, if you are sharing models between the browser and server, you probably want the server-side code to communicate with the database, whereas the browser-side code should not.
// The Todo type and its fields can be shared between the server and browser.
type Todo struct {
Title string
IsCompleted bool
}
// The Toggle method can be called server-side or browser-side because it does
// not touch the database.
func (t *Todo) Toggle() {
t.IsCompleted = !t.IsCompleted
}
// The Save method however, should have different behavior depending on whether
// we are running on the server or browser.
func (t *Todo) Save() {
switch {
case detect.IsBrowser():
// In this case, we might want to save to local storage first, and then
// try to sync with the server using WebSockets or http.
case detect.IsServer():
// In this case, we want to save directly to the database.
}
}
How it Works
To see if code is running as javascript, detect checks whether js.Global
is nil. js.Global is a special gopherjs property that is only non-nil when
code is compiled to javascript.
To see if code is running in the browser, detect checks for the existence of a global javascript "document" property. If it is defined, detect assumes the code is running in the browser.
We encourage you to check out the source code if you're curious about how detect works under the hood. It's really tiny (only a single file) and pretty straightforward.
Contributing
See CONTRIBUTING.md
License
Detect is licensed under the MIT License. See the LICENSE file for more information.
Documentation
¶
Overview ¶
Package detect is a tiny package for detecting whether code is running on the server or browser. It is intended to be used with hybrid go applications and gopherjs.
Version 0.1.2
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func IsBrowser ¶
func IsBrowser() bool
IsBrowser returns true iff the code that is currently running is compiled javascript code running in a browser. It works by checking if the global "document" property exists.
func IsGo ¶
func IsGo() bool
IsGo returns true iff the code that is currently running is pure go code. That is, it has not been compiled to javascript. It works by checking if the js.Global property is nil.
func IsJavascript ¶
func IsJavascript() bool
IsJavascript return true iff the code that is currently running is transpiled javascript code. It works by checking if the js.Global property is non-nil.
Types ¶
This section is empty.
Source Files