package homedir

Import Path
	github.com/mitchellh/go-homedir (on go.dev)

Dependency Relation
	imports 9 packages, and imported by 2 packages

Involved Source Files

	      homedir.go
Package-Level Functions (total 5, in which 3 are exported)

	 func Dir() (string, error)
		Dir returns the home directory for the executing user.

		This uses an OS-specific method for discovering the home directory.
		An error is returned if a home directory cannot be detected.

	 func Expand(path string) (string, error)
		Expand expands the path to include the home directory if the path
		is prefixed with `~`. If it isn't prefixed with `~`, the path is
		returned as-is.

	 func Reset()
		Reset clears the cache, forcing the next call to Dir to re-detect
		the home directory. This generally never has to be called, but can be
		useful in tests if you're modifying the home directory via the HOME
		env var or something.

	/* 2 unexporteds ... *//* 2 unexporteds: */
	 func dirUnix() (string, error)
	 func dirWindows() (string, error)
Package-Level Variables (total 3, in which 1 are exported)

	  var DisableCache bool
		DisableCache will disable caching of the home directory. Caching is enabled
		by default.

	/* 2 unexporteds ... *//* 2 unexporteds: */
	  var cacheLock sync.RWMutex
	  var homedirCache string

The pages are generated with Golds v0.3.2-preview. (GOOS=darwin GOARCH=amd64)
Golds is a Go 101 project developed by Tapir Liu.
PR and bug reports are welcome and can be submitted to the issue list.
Please follow @Go100and1 (reachable from the left QR code) to get the latest news of Golds.