pear-user-dirs v1.0.2

pear-user-dirs

Get the path of user-specific directories on all major platforms

npm install pear-user-dirs

Usage

Use pear-user-dirs to get the Downloads directory:

const pearUserDirs = require('pear-user-dirs')

pearUserDirs().then(dirs => {
  console.log('Downloads folder path:', dirs.downloads)
})

pearUserDirs({ asFileLinks: true }).then(dirs => {
  console.log('Downloads folder path as URL:', dirs.downloads)
})

const pearUserDirs = require('pear-user-dirs')

const dirs = pearUserDirs({ sync: true })
console.log('Downloads folder path:', dirs.downloads)

const dirsURL = pearUserDirs({ sync: true, asFileLinks: true })
console.log('Downloads folder path as URL:', dirsURL.downloads)

API

pearUserDirs(opts)

• opts:
  • sync (boolean): If true, directly returns an object with the paths of the user directories, otherwise returns a Promise. Default is false.
  • asFileLinks (boolean): If true, returns the path as a file URL. Default is false.

License

Apache-2.0