xdg-basedir

WebJar for xdg-basedir

License	MIT
GroupId	org.webjars.npm
ArtifactId	xdg-basedir
Last Version	4.0.0
Release Date	Aug 19, 2020
Type	jar
Description	xdg-basedir WebJar for xdg-basedir
Project URL	https://www.webjars.org
Source Code Management	https://github.com/sindresorhus/xdg-basedir

Download xdg-basedir

Filename	Size
xdg-basedir-4.0.0.pom
xdg-basedir-4.0.0.jar	5 KB
xdg-basedir-4.0.0-sources.jar	22 bytes
xdg-basedir-4.0.0-javadoc.jar	22 bytes

How to add to project

Apache Maven

<!-- https://jarcasting.com/artifacts/org.webjars.npm/xdg-basedir/ -->
<dependency>
    <groupId>org.webjars.npm</groupId>
    <artifactId>xdg-basedir</artifactId>
    <version>4.0.0</version>
</dependency>

Gradle Groovy

// https://jarcasting.com/artifacts/org.webjars.npm/xdg-basedir/
implementation 'org.webjars.npm:xdg-basedir:4.0.0'

Gradle Kotlin

// https://jarcasting.com/artifacts/org.webjars.npm/xdg-basedir/
implementation ("org.webjars.npm:xdg-basedir:4.0.0")

Apache Buildr

'org.webjars.npm:xdg-basedir:jar:4.0.0'

Apache Ivy

<dependency org="org.webjars.npm" name="xdg-basedir" rev="4.0.0">
  <artifact name="xdg-basedir" type="jar" />
</dependency>

Groovy Grape

@Grapes(
@Grab(group='org.webjars.npm', module='xdg-basedir', version='4.0.0')
)

Scala SBT

libraryDependencies += "org.webjars.npm" % "xdg-basedir" % "4.0.0"

Leiningen

[org.webjars.npm/xdg-basedir "4.0.0"]

Dependencies

There are no dependencies for this project. It is a standalone project that does not depend on any other jars.

Project Modules

There are no modules declared in this project.

xdg-basedir

Get XDG Base Directory paths

This package is meant for Linux. You should not use XDG on macOS and Windows. Instead, you should follow their platform conventions. You can use env-paths for that.

Install

$ npm install xdg-basedir

Usage

const xdgBasedir = require('xdg-basedir');

xdgBasedir.data;
//=> '/home/sindresorhus/.local/share'

xdgBasedir.config;
//=> '/home/sindresorhus/.config'

xdgBasedir.dataDirs
//=> ['/home/sindresorhus/.local/share', '/usr/local/share/', '/usr/share/']

API

The properties .data, .config, .cache, .runtime will return null in the uncommon case that both the XDG environment variable is not set and the users home directory can't be found. You need to handle this case. A common solution is to fall back to a temp directory.

.data

Directory for user-specific data files.

.config

Directory for user-specific configuration files.

.cache

Directory for user-specific non-essential data files.

.runtime

Directory for user-specific non-essential runtime files and other file objects (such as sockets, named pipes, etc).

.dataDirs

Preference-ordered array of base directories to search for data files in addition to .data.

.configDirs

Preference-ordered array of base directories to search for configuration files in addition to .config.

---

Get professional support for this package with a Tidelift subscription
_{Tidelift helps make open source sustainable for maintainers while giving companies
assurances about security, maintenance, and licensing for their dependencies.}

Versions

Version
4.0.0 Aug 19, 2020
3.0.0 Mar 14, 2017
2.0.0 Apr 7, 2016
1.0.0 Jun 20, 2015