.gitignore added
[dotfiles/.git] / .config / coc / extensions / node_modules / coc-prettier / node_modules / slash / readme.md
1 # slash [![Build Status](https://travis-ci.org/sindresorhus/slash.svg?branch=master)](https://travis-ci.org/sindresorhus/slash)
2
3 > Convert Windows backslash paths to slash paths: `foo\\bar` ➔ `foo/bar`
4
5 [Forward-slash paths can be used in Windows](http://superuser.com/a/176395/6877) as long as they're not extended-length paths and don't contain any non-ascii characters.
6
7 This was created since the `path` methods in Node outputs `\\` paths on Windows.
8
9
10 ## Install
11
12 ```sh
13 $ npm install --save slash
14 ```
15
16
17 ## Usage
18
19 ```js
20 var path = require('path');
21 var slash = require('slash');
22
23 var str = path.join('foo', 'bar');
24 // Unix    => foo/bar
25 // Windows => foo\\bar
26
27 slash(str);
28 // Unix    => foo/bar
29 // Windows => foo/bar
30 ```
31
32
33 ## API
34
35 ### slash(path)
36
37 Type: `string`
38
39 Accepts a Windows backslash path and returns a slash path.
40
41
42 ## License
43
44 MIT © [Sindre Sorhus](http://sindresorhus.com)