Accept file URL instances

sindresorhus · sindresorhus · commit 776fb013ca43 · 2025-09-11T00:43:58.000+07:00
Fixes #36
diff --git a/index.d.ts b/index.d.ts
@@ -46,7 +46,7 @@ console.log(paths);
 // ]
 ```
 */
-export function makeDirectory(path: string, options?: Options): Promise<string>;
+export function makeDirectory(path: string | URL, options?: Options): Promise<string>;
 
 /**
 Synchronously make a directory and its parents if needed - Think `mkdir -p`.
@@ -64,4 +64,4 @@ console.log(path);
 //=> '/Users/sindresorhus/fun/unicorn/rainbow/cake'
 ```
 */
-export function makeDirectorySync(path: string, options?: Options): string;
+export function makeDirectorySync(path: string | URL, options?: Options): string;
diff --git a/index.js b/index.js
@@ -2,6 +2,15 @@ import process from 'node:process';
 import fs from 'node:fs';
 import fsPromises from 'node:fs/promises';
 import path from 'node:path';
+import {fileURLToPath} from 'node:url';
+
+const toPath = urlOrPath => {
+	if (urlOrPath instanceof URL) {
+		return fileURLToPath(urlOrPath);
+	}
+
+	return urlOrPath;
+};
 
 // https://github.com/nodejs/node/issues/8987
 // https://github.com/libuv/libuv/pull/1088
@@ -41,6 +50,7 @@ const permissionError = pth => {
 };
 
 export async function makeDirectory(input, options) {
+	input = toPath(input);
 	checkPath(input);
 	options = processOptions(options);
 
@@ -96,6 +106,7 @@ export async function makeDirectory(input, options) {
 }
 
 export function makeDirectorySync(input, options) {
+	input = toPath(input);
 	checkPath(input);
 	options = processOptions(options);
 
diff --git a/readme.md b/readme.md
@@ -81,7 +81,7 @@ Returns the path to the created directory.
 
 #### path
 
-Type: `string`
+Type: `string | URL`
 
 The directory to create.
 
diff --git a/test/async.js b/test/async.js
@@ -1,6 +1,7 @@
 import process from 'node:process';
 import fs from 'node:fs';
 import path from 'node:path';
+import {pathToFileURL} from 'node:url';
 import test from 'ava';
 import {temporaryDirectory, temporaryFile} from 'tempy';
 import gracefulFs from 'graceful-fs';
@@ -118,6 +119,22 @@ test.serial('handles invalid path characters', async t => {
 	});
 });
 
+test('accepts URL instance', async t => {
+	const directory = getFixture();
+	const urlPath = pathToFileURL(directory);
+	const madeDirectory = await makeDirectory(urlPath);
+	t.true(madeDirectory.length > 0);
+	assertDirectory(t, madeDirectory);
+});
+
+test('accepts URL instance with custom fs', async t => {
+	const directory = getFixture();
+	const urlPath = pathToFileURL(directory);
+	const madeDirectory = await makeDirectory(urlPath, customFsOptions);
+	t.true(madeDirectory.length > 0);
+	assertDirectory(t, madeDirectory);
+});
+
 test('preserves EACCES error when parent directory lacks execute permission', async t => {
 	if (process.platform === 'win32') {
 		t.pass('Skip on Windows');
diff --git a/test/sync.js b/test/sync.js
@@ -1,6 +1,7 @@
 import process from 'node:process';
 import fs from 'node:fs';
 import path from 'node:path';
+import {pathToFileURL} from 'node:url';
 import test from 'ava';
 import {temporaryDirectory, temporaryFile} from 'tempy';
 import gracefulFs from 'graceful-fs';
@@ -107,6 +108,22 @@ test('handles null bytes in path', t => {
 	t.regex(error.code, /ERR_INVALID_ARG_VALUE|ENOENT/);
 });
 
+test('accepts URL instance', t => {
+	const directory = getFixture();
+	const urlPath = pathToFileURL(directory);
+	const madeDirectory = makeDirectorySync(urlPath);
+	t.true(madeDirectory.length > 0);
+	assertDirectory(t, madeDirectory);
+});
+
+test('accepts URL instance with custom fs', t => {
+	const directory = getFixture();
+	const urlPath = pathToFileURL(directory);
+	const madeDirectory = makeDirectorySync(urlPath, customFsOptions);
+	t.true(madeDirectory.length > 0);
+	assertDirectory(t, madeDirectory);
+});
+
 test('preserves EACCES error when parent directory lacks execute permission', t => {
 	if (process.platform === 'win32') {
 		t.pass('Skip on Windows');
