summaryrefslogtreecommitdiff
path: root/node_modules/slash/index.d.ts
diff options
context:
space:
mode:
Diffstat (limited to 'node_modules/slash/index.d.ts')
-rw-r--r--node_modules/slash/index.d.ts23
1 files changed, 23 insertions, 0 deletions
diff --git a/node_modules/slash/index.d.ts b/node_modules/slash/index.d.ts
new file mode 100644
index 0000000..692c7fd
--- /dev/null
+++ b/node_modules/slash/index.d.ts
@@ -0,0 +1,23 @@
+/**
+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.
+
+@param path - A Windows backslash path.
+@returns A path with forward slashes.
+
+@example
+```
+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
+```
+*/
+export default function slash(path: string): string;