Package Exports
- @stdlib/utils-convert-path
- @stdlib/utils-convert-path/lib/index.js
This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (@stdlib/utils-convert-path) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.
Readme
Convert Path
Convert between POSIX and Windows paths.
Installation
npm install @stdlib/utils-convert-pathUsage
var convertPath = require( '@stdlib/utils-convert-path' );convertPath( from, to )
Converts between POSIX and Windows paths.
var p = convertPath( 'C:\\foo\\bar', 'posix' );
// returns '/c/foo/bar'The following output path conventions are supported:
- win32: Windows path convention; e.g.,
C:\\foo\\bar. - mixed: mixed path convention (Windows volume convention and POSIX path separator); e.g.,
C:/foo/bar. - posix: POSIX path convention; e.g.,
/c/foo/bar.
Notes
- A Windows extended-length path cannot be converted to either a
mixedorposixpath convention, as forward slashes cannot be used as path separators. - If a POSIX path begins with
/[A-Za-z]/(e.g.,/c/), the path is assumed to begin with a volume name. - The function makes no attempt to verify that a provided path is valid.
Examples
var convertPath = require( '@stdlib/utils-convert-path' );
var p1;
var p2;
p1 = '/c/foo/bar/beep.c';
p2 = convertPath( p1, 'win32' );
// returns 'c:\foo\bar\beep.c'
p1 = '/c/foo/bar/beep.c';
p2 = convertPath( p1, 'mixed' );
// returns 'c:/foo/bar/beep.c'
p1 = '/c/foo/bar/beep.c';
p2 = convertPath( p1, 'posix' );
// returns '/c/foo/bar/beep.c'
p1 = 'C:\\\\foo\\bar\\beep.c';
p2 = convertPath( p1, 'win32' );
// returns 'C:\\foo\bar\beep.c'
p1 = 'C:\\\\foo\\bar\\beep.c';
p2 = convertPath( p1, 'mixed' );
// returns 'C:/foo/bar/beep.c'
p1 = 'C:\\\\foo\\bar\\beep.c';
p2 = convertPath( p1, 'posix' );
// returns '/c/foo/bar/beep.c'CLI
Installation
To use the module as a general utility, install the module globally
npm install -g @stdlib/utils-convert-pathUsage
Usage: convert-path [options] [<path>] --out=<output>
Options:
-h, --help Print this message.
-V, --version Print the package version.
-o, --out output Output path convention.Examples
$ convert-path /c/foo/bar --out=mixed
c:/foo/barTo use as a standard stream,
$ echo -n '/c/foo/bar' | convert-path --out=win32
c:\foo\barNotice
This package is part of stdlib, a standard library for JavaScript and Node.js, with an emphasis on numerical and scientific computing. The library provides a collection of robust, high performance libraries for mathematics, statistics, streams, utilities, and more.
For more information on the project, filing bug reports and feature requests, and guidance on how to develop stdlib, see the main project repository.
Community
License
See LICENSE.
Copyright
Copyright © 2016-2022. The Stdlib Authors.