summaryrefslogtreecommitdiff
path: root/node_modules/slash/readme.md
diff options
context:
space:
mode:
Diffstat (limited to 'node_modules/slash/readme.md')
-rw-r--r--node_modules/slash/readme.md36
1 files changed, 36 insertions, 0 deletions
diff --git a/node_modules/slash/readme.md b/node_modules/slash/readme.md
new file mode 100644
index 0000000..42f74f9
--- /dev/null
+++ b/node_modules/slash/readme.md
@@ -0,0 +1,36 @@
+# slash
+
+> Convert Windows backslash paths to slash paths: `foo\\bar` ➔ `foo/bar`
+
+[Forward-slash paths can be used in Windows](http://superuser.com/a/176395/6877) as long as they're not extended-length paths.
+
+This was created since the `path` methods in Node.js outputs `\\` paths on Windows.
+
+## Install
+
+```sh
+npm install slash
+```
+
+## Usage
+
+```js
+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.