tempfile 4.0.0 → 5.0.0

package/index.d.ts

@@ -1,17 +1,30 @@
+export type Options = {
+	/**
+	A file extension to append to the path.
+
+	@example
+	```
+	import tempfile from 'tempfile';
+
+	tempfile();
+	//=> '/var/folders/3x/jf5977fn79jbglr7rk0tq4d00000gn/T/6271e235-13b9-4138-8b9b-ee2f26c09ce3'
+
+	tempfile({extension: 'png'});
+	//=> '/var/folders/3x/jf5977fn79jbglr7rk0tq4d00000gn/T/4049f192-43e7-43b2-98d9-094e6760861b.png'
+	```
+	*/
+	readonly extension?: string;
+};
+
 /**
 Get a random temporary file path.
 
-@param extension - Extension to append to the path.
-
 @example
 ```
 import tempfile from 'tempfile';
 
-tempfile('.png');
-//=> '/var/folders/3x/jf5977fn79jbglr7rk0tq4d00000gn/T/4049f192-43e7-43b2-98d9-094e6760861b.png'
-
 tempfile();
 //=> '/var/folders/3x/jf5977fn79jbglr7rk0tq4d00000gn/T/6271e235-13b9-4138-8b9b-ee2f26c09ce3'
 ```
 */
-export default function tempfile(extension?: string): string;
+export default function tempfile(options?: Options): string;

package/index.js

@@ -1,7 +1,18 @@
 import path from 'node:path';
-import {v4 as uuidv4} from 'uuid';
+import {randomUUID} from 'node:crypto';
 import tempDirectory from 'temp-dir';
 
-export default function tempfile(extension = '') {
-	return path.join(tempDirectory, uuidv4() + extension);
+export default function tempfile(options = {}) {
+	// TODO: Remove this for v6.
+	if (typeof options === 'string') {
+		throw new TypeError('You must now pass in the file extension as an object.');
+	}
+
+	let {extension} = options;
+
+	if (typeof extension === 'string') {
+		extension = extension.startsWith('.') ? extension : `.${extension}`;
+	}
+
+	return path.join(tempDirectory, randomUUID() + (extension ?? ''));
 }

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "tempfile",
-	"version": "4.0.0",
+	"version": "5.0.0",
 	"description": "Get a random temporary file path",
 	"license": "MIT",
 	"repository": "sindresorhus/tempfile",
@@ -11,9 +11,12 @@
 		"url": "https://sindresorhus.com"
 	},
 	"type": "module",
-	"exports": "./index.js",
+	"exports": {
+		"types": "./index.d.ts",
+		"default": "./index.js"
+	},
 	"engines": {
-		"node": ">=12.20"
+		"node": ">=14.18"
 	},
 	"scripts": {
 		"test": "xo && ava && tsd"
@@ -32,12 +35,11 @@
 		"uuid"
 	],
 	"dependencies": {
-		"temp-dir": "^2.0.0",
-		"uuid": "^8.3.2"
+		"temp-dir": "^3.0.0"
 	},
 	"devDependencies": {
-		"ava": "^3.15.0",
-		"tsd": "^0.17.0",
-		"xo": "^0.40.2"
+		"ava": "^5.2.0",
+		"tsd": "^0.25.0",
+		"xo": "^0.53.1"
 	}
 }

package/readme.md

@@ -6,8 +6,8 @@
 
 ## Install
 
-```
-$ npm install tempfile
+```sh
+npm install tempfile
 ```
 
 ## Usage
@@ -15,22 +15,33 @@ $ npm install tempfile
 ```js
 import tempfile from 'tempfile';
 
-tempfile('.png');
-//=> '/var/folders/3x/jf5977fn79jbglr7rk0tq4d00000gn/T/4049f192-43e7-43b2-98d9-094e6760861b.png'
-
 tempfile();
 //=> '/var/folders/3x/jf5977fn79jbglr7rk0tq4d00000gn/T/6271e235-13b9-4138-8b9b-ee2f26c09ce3'
 ```
 
 ## API
 
-### tempfile(extension?)
+### tempfile(options?)
+
+#### options
 
-#### extension
+Type: `object`
+
+##### extension
 
 Type: `string`
 
-Extension to append to the path.
+A file extension to append to the path.
+
+```js
+import tempfile from 'tempfile';
+
+tempfile();
+//=> '/var/folders/3x/jf5977fn79jbglr7rk0tq4d00000gn/T/6271e235-13b9-4138-8b9b-ee2f26c09ce3'
+
+tempfile({extension: 'png'});
+//=> '/var/folders/3x/jf5977fn79jbglr7rk0tq4d00000gn/T/4049f192-43e7-43b2-98d9-094e6760861b.png'
+```
 
 ## Related