os-paths

os-paths

Generate portable common OS paths (home and temp)

 

Installation

npm install os-paths

Requirements

NodeJS >= 6.0

Usage

const osPaths = require('os-paths');

osPaths.home();
//(*nix) => '/home/rivy'
//(win)  => 'C:\Users\RIvy'

osPaths.temp();
//(*nix) => '/tmp'
//(win)  => 'C:\temp'

API

Initialization

require('os-paths'): OSPaths()

const osPaths = require('os-paths');

The object returned by the module constructor is an OSPaths function object, augmented with attached methods. When called directly (eg, const p = osPaths()), it returns a newly constructed OSPaths object. Since the OSPaths object contains no instance state, all constructed objects will be functionally identical.

Methods

All module methods return simple, platform-compatible, path strings.

The path strings are not guaranteed to already exist on the file system. So, the user is responsible for directory construction, if/when needed. However, since all of these are standard OS directories, they should all exist without the need for user intervention.

If/when necessary, make-dir or mkdirp can be used to create the directories.

osPaths.home(): string

Returns the home directory for user

osPaths.temp(): string

Returns the directory for temporary files

XDG

All XDG-related methods have been relocated to the xdg-portable and xdg-app-paths modules.

Related

• xdg-app-paths ... easy XDG for applications
• xdg-portable ... XDG Base Directory paths (cross-platform)

License

MIT © Roy Ivy III, Sindre Sorhus