goenv

Documentation

Overview

Package goenv returns environment variables that are used in various parts of the compiler. You can query it manually with the `tinygo env` subcommand.

Index

• Constants
• Variables
• func Get(name string) string
• func GetGorootVersion(goroot string) (major, minor int, err error)
• func GorootVersionString(goroot string) (string, error)

Constants

const Version = "0.17.0"

Version of TinyGo. Update this value before release of new version of software.

Variables

var Keys = []string{
	"GOOS",
	"GOARCH",
	"GOROOT",
	"GOPATH",
	"GOCACHE",
	"CGO_ENABLED",
	"TINYGOROOT",
}

Keys is a slice of all available environment variable keys.

var TINYGOROOT string

TINYGOROOT is the path to the final location for checking tinygo files. If unset (by a -X ldflag), then sourceDir() will fallback to the original build directory.

Functions

func Get

func Get(name string) string

Get returns a single environment variable, possibly calculating it on-demand. The empty string is returned for unknown environment variables.

func GetGorootVersion

func GetGorootVersion(goroot string) (major, minor int, err error)

GetGorootVersion returns the major and minor version for a given GOROOT path. If the goroot cannot be determined, (0, 0) is returned.

func GorootVersionString

func GorootVersionString(goroot string) (string, error)

GorootVersionString returns the version string as reported by the Go toolchain for the given GOROOT path. It is usually of the form `go1.x.y` but can have some variations (for beta releases, for example).