Skip to content

JavaScript library for determining appropriate platform-specific directories (port of Python appdirs)

License

Notifications You must be signed in to change notification settings

building5/appdirsjs

Folders and files

NameName
Last commit message
Last commit date

Latest commit

Dec 22, 2016
0c1a98e · Dec 22, 2016

History

20 Commits
Apr 24, 2014
Dec 21, 2016
Mar 11, 2014
Mar 11, 2014
Mar 11, 2014
Apr 4, 2014
Dec 21, 2016
Dec 22, 2016
Mar 14, 2014
Apr 1, 2014
Mar 11, 2014
Dec 21, 2016
Dec 22, 2016

Repository files navigation

AppDirs.js

Build Status

The wonderful thing about standards is that there are so many of them to choose from.

-- Andrew Tanenbaum

When it comes to storing application data, the convention on where to store your data varies from platform to platform.

This package is a port of the Python appdirs library, which provides a small set of methods which can be used to locate the preferred directories for user and site data for an application.

It currently supports OS X and Unix operating systems (Unix support is according to the XDG specification). Windows support is not yet implemented, but a pull request adding that would be greatly appreciated!

Installation

AppDirs.js is hosted on NPM, so you can simply install it, and add it to your package.json as a dependency.

$ npm install --save appdirs

Directories

The directories the AppDirs.js can help you locate are:

  • user data dir (user_data_dir)
  • user config dir (user_config_dir)
  • user cache dir (user_cache_dir)
  • site data dir (site_data_dir)
  • site config dir (site_config_dir)
  • user log dir (user_log_dir)

Usage

See the JSDocs for specifics on using the API.

About

JavaScript library for determining appropriate platform-specific directories (port of Python appdirs)

Resources

License

Stars

Watchers

Forks

Packages

No packages published