Class: AppDirs

appdirs~ AppDirs

new AppDirs(appname, appauthor, version, roaming, multipath)

Build an AppDirs convenience object.

Parameters:

Name	Type	Argument	Description
`appname`	string		Application name.
`appauthor`	string	<optional>	Application author. Defaults to appname.
`version`	string	<optional>	Application version.
`roaming`	boolean	<optional>	If true, use directory for roaming profile.
`multipath`	boolean	<optional>	If true, return arrays for multipath functions (siteDataDir, siteConfigDir).

Source:

index.js, line 193

Methods

siteConfigDir() → {string}

Site configuration directory.

Source:

index.js, line 241

Returns:

Type: string

siteDataDir() → {string}

Site data directory.

Source:

index.js, line 232

Returns:

Type: string

userCacheDir() → {string}

User cache directory.

Source:

index.js, line 224

Returns:

Type: string

userConfigDir() → {string}

User configuration directory.

Source:

index.js, line 215

Returns:

Type: string

userDataDir() → {string}

User data directory.

Source:

index.js, line 206

Returns:

Type: string

userLogDir() → {string}

User log directory.

Source:

index.js, line 250

Returns:

Type: string