ospath

What is ospath?

The ospath npm package provides a simple and consistent way to work with operating system-specific path operations. It abstracts away the differences between Windows and POSIX (Unix-like) systems, allowing developers to write code that works seamlessly across different environments. This package is particularly useful for file path manipulation, construction, and normalization.

What are ospath's main functionalities?

Home Directory

Retrieves the current user's home directory in a cross-platform way.

const ospath = require('ospath');
console.log(ospath.home());

Temporary Directory

Provides the path to the system's temporary directory, which is useful for storing temporary files.

const ospath = require('ospath');
console.log(ospath.tmp());

Data Directory

Gets the path to the system's data directory where applications can store application-specific data.

const ospath = require('ospath');
console.log(ospath.data());

Other packages similar to ospath

path

The 'path' module is a core Node.js module that provides utilities for working with file and directory paths. It is similar to ospath in that it helps with path manipulation, but it does not automatically handle OS-specific differences.

README

ospath

A JavaScript component that provides operating specific path values.

Installation

npm i --save ospath

API

ospath.data()

Returns the directory where an application should store its data directory.

• Windows: %APPDATA%
• OS X: ~/Library/Application Support
• Unix-like: $XDG_CONFIG_HOME or ~/.config

ospath.desktop()

Returns the users desktop directory. On every OS, this is just the home() dir and Desktop.

ospath.home()

Returns the user's home directory.

• Windows: %USERPROFILE%
• Unix-like: $HOME

ospath.tmp()

Returns a temporary directory. Could also use require('os').tmpdir().

• Windows: %TEMP%
• Unix-like: /tmp

License

MIT