underscore

README

underscore

-- import "github.com/robertkrimen/otto/underscore"

Package underscore contains the source for the JavaScript utility-belt library.

import (
	_ "github.com/robertkrimen/otto/underscore"
)
// Every Otto runtime will now include underscore

http://underscorejs.org

https://github.com/documentcloud/underscore

By importing this package, you'll automatically load underscore every time you create a new Otto runtime.

To prevent this behavior, you can do the following:

import (
	"github.com/robertkrimen/otto/underscore"
)

func init() {
	underscore.Disable()
}

Usage

func Disable

func Disable()

Disable underscore runtime inclusion.

func Enable

func Enable()

Enable underscore runtime inclusion.

func Source

func Source() string

Source returns the underscore source.

-- godocdown http://github.com/robertkrimen/godocdown

Documentation

Overview

Package underscore contains the source for the JavaScript utility-belt library.

import (
	_ "github.com/robertkrimen/otto/underscore"
)
// Every Otto runtime will now include underscore

http://underscorejs.org

https://github.com/documentcloud/underscore

By importing this package, you'll automatically load underscore every time you create a new Otto runtime.

To prevent this behavior, you can do the following:

import (
	"github.com/robertkrimen/otto/underscore"
)

func init() {
	underscore.Disable()
}

Index

• func Asset(name string) ([]byte, error)
• func AssetDir(name string) ([]string, error)
• func AssetInfo(name string) (os.FileInfo, error)
• func AssetNames() []string
• func Disable()
• func Enable()
• func MustAsset(name string) []byte
• func RestoreAsset(dir, name string) error
• func RestoreAssets(dir, name string) error
• func Source() string

Functions

func Asset

func Asset(name string) ([]byte, error)

Asset loads and returns the asset for the given name. It returns an error if the asset could not be found or could not be loaded.

func AssetDir

func AssetDir(name string) ([]string, error)

AssetDir returns the file names below a certain directory embedded in the file by go-bindata. For example if you run go-bindata on data/... and data contains the following hierarchy:

data/
  foo.txt
  img/
    a.png
    b.png

then AssetDir("data") would return []string{"foo.txt", "img"} AssetDir("data/img") would return []string{"a.png", "b.png"} AssetDir("foo.txt") and AssetDir("notexist") would return an error AssetDir("") will return []string{"data"}.

func AssetInfo

func AssetInfo(name string) (os.FileInfo, error)

AssetInfo loads and returns the asset info for the given name. It returns an error if the asset could not be found or could not be loaded.

func AssetNames

func AssetNames() []string

AssetNames returns the names of the assets.

func Disable

func Disable()

Disable underscore runtime inclusion.

func Enable

func Enable()

Enable underscore runtime inclusion.

func MustAsset

func MustAsset(name string) []byte

MustAsset is like Asset but panics when Asset would return an error. It simplifies safe initialization of global variables.

func RestoreAsset

func RestoreAsset(dir, name string) error

RestoreAsset restores an asset under the given directory

func RestoreAssets

func RestoreAssets(dir, name string) error

RestoreAssets restores an asset under the given directory recursively

func Source

func Source() string

Source returns the underscore source.