docs(path): add note about unstable-join (#5967)

denoland · Sep 12, 2024 · d35803f · d35803f
1 parent c5d7930
commit d35803f
Show file tree

Hide file tree

Showing 3 changed files with 9 additions and 0 deletions.
diff --git a/path/join.ts b/path/join.ts
@@ -20,6 +20,9 @@ import { join as windowsJoin } from "./windows/join.ts";
  * }
  * ```
  *
+ * Note: If you are working with file URLs,
+ * use the new version of `join` from `@std/path/unstable-join`.
+ *
  * @param paths Paths to be joined and normalized.
  * @returns The joined and normalized path.
  */

diff --git a/path/posix/join.ts b/path/posix/join.ts
@@ -16,6 +16,9 @@ import { normalize } from "./normalize.ts";
  * assertEquals(path, "/foo/bar/baz/asdf");
  * ```
  *
+ * Note: If you are working with file URLs,
+ * use the new version of `join` from `@std/path/posix/unstable-join`.
+ *
  * @param paths The paths to join.
  * @returns The joined path.
  */

diff --git a/path/windows/join.ts b/path/windows/join.ts
@@ -17,6 +17,9 @@ import { normalize } from "./normalize.ts";
  * assertEquals(joined, "C:\\foo\\bar");
  * ```
  *
+ * Note: If you are working with file URLs,
+ * use the new version of `join` from `@std/path/windows/unstable-join`.
+ *
  * @param paths The paths to join.
  * @returns The joined path.
  */