# Convert Path
[![NPM version][npm-image]][npm-url] [![Build Status][test-image]][test-url] [![Coverage Status][coverage-image]][coverage-url]
> Convert between POSIX and Windows paths.
## Installation
```bash
npm install @stdlib/utils-convert-path
```
## Usage
```javascript
var convertPath = require( '@stdlib/utils-convert-path' );
```
#### convertPath( from, to )
Converts between POSIX and Windows paths.
```javascript
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][extended-length-path] **cannot** be converted to either a `mixed` or `posix` path 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
```javascript
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
```bash
npm install -g @stdlib/utils-convert-path
```
### Usage
```text
Usage: convert-path [options] [] --out=
### Examples
```bash
$ convert-path /c/foo/bar --out=mixed
c:/foo/bar
```
To use as a [standard stream][standard-streams],
```bash
$ echo -n '/c/foo/bar' | convert-path --out=win32
c:\foo\bar
```
* * *
## Notice
This package is part of [stdlib][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][stdlib], see the main project [repository][stdlib].
#### Community
[![Chat][chat-image]][chat-url]
---
## License
See [LICENSE][stdlib-license].
## Copyright
Copyright © 2016-2022. The Stdlib [Authors][stdlib-authors].
[npm-image]: http://img.shields.io/npm/v/@stdlib/utils-convert-path.svg
[npm-url]: https://npmjs.org/package/@stdlib/utils-convert-path
[test-image]: https://github.com/stdlib-js/utils-convert-path/actions/workflows/test.yml/badge.svg
[test-url]: https://github.com/stdlib-js/utils-convert-path/actions/workflows/test.yml
[coverage-image]: https://img.shields.io/codecov/c/github/stdlib-js/utils-convert-path/main.svg
[coverage-url]: https://codecov.io/github/stdlib-js/utils-convert-path?branch=main
[umd]: https://github.com/umdjs/umd
[es-module]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Modules
[deno-url]: https://github.com/stdlib-js/utils-convert-path/tree/deno
[umd-url]: https://github.com/stdlib-js/utils-convert-path/tree/umd
[esm-url]: https://github.com/stdlib-js/utils-convert-path/tree/esm
[chat-image]: https://img.shields.io/gitter/room/stdlib-js/stdlib.svg
[chat-url]: https://gitter.im/stdlib-js/stdlib/
[stdlib]: https://github.com/stdlib-js/stdlib
[stdlib-authors]: https://github.com/stdlib-js/stdlib/graphs/contributors
[stdlib-license]: https://raw.githubusercontent.com/stdlib-js/utils-convert-path/main/LICENSE
[extended-length-path]: https://msdn.microsoft.com/en-us/library/windows/desktop/aa365247(v=vs.85).aspx
[standard-streams]: https://en.wikipedia.org/wiki/Standard_streams