slash

What is slash?

The 'slash' npm package is used to convert Windows backslash paths to slash paths, which are commonly used in Unix-based systems. This is particularly useful when working with file paths in a cross-platform environment, ensuring that paths are handled consistently across different operating systems.

What are slash's main functionalities?

Convert Windows backslash paths to slash paths

This feature takes a Windows-style backslash path and converts it to a Unix-style slash path. It's useful for ensuring that file paths are compatible with Unix-based systems or tools that expect forward slashes.

const slash = require('slash');
const path = 'C:\\Users\\User\\file.txt';
const convertedPath = slash(path);
console.log(convertedPath); // 'C:/Users/User/file.txt'

Other packages similar to slash

upath

The 'upath' package extends the native 'path' module and normalizes paths to always use forward slashes. It provides similar functionality to 'slash' but also includes other path manipulation utilities.

normalize-path

The 'normalize-path' package is used to remove trailing slashes and convert Windows backslash paths to slash paths. It is similar to 'slash' but also focuses on normalizing paths by removing redundant slashes.

README

slash

Convert Windows backslash paths to slash paths: foo\\bar ➔ foo/bar

Forward-slash paths can be used in Windows as long as they're not extended-length paths.

This was created since the path methods in Node.js outputs \\ paths on Windows.

Install

npm install slash

Usage

import path from 'node:path';
import slash from 'slash';

const string = path.join('foo', 'bar');
// Unix    => foo/bar
// Windows => foo\\bar

slash(string);
// Unix    => foo/bar
// Windows => foo/bar

API

slash(path)

Type: string

Accepts a Windows backslash path and returns a path with forward slashes.