tempfile 3.0.0 → 5.0.0

package/index.d.ts

@@ -1,19 +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 = require('tempfile');
-
-tempfile('.png');
-//=> '/var/folders/3x/jf5977fn79jbglr7rk0tq4d00000gn/T/4049f192-43e7-43b2-98d9-094e6760861b.png'
+import tempfile from 'tempfile';
 
 tempfile();
 //=> '/var/folders/3x/jf5977fn79jbglr7rk0tq4d00000gn/T/6271e235-13b9-4138-8b9b-ee2f26c09ce3'
 ```
 */
-declare function tempfile(extension?: string): string;
-
-export = tempfile;
+export default function tempfile(options?: Options): string;

package/index.js

@@ -1,6 +1,18 @@
-'use strict';
-const path = require('path');
-const uuid = require('uuid');
-const tempDirectory = require('temp-dir');
+import path from 'node:path';
+import {randomUUID} from 'node:crypto';
+import tempDirectory from 'temp-dir';
 
-module.exports = (extension = '') => path.join(tempDirectory, uuid.v4() + 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/license

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) Sindre Sorhus <sindresorhus@gmail.com> (sindresorhus.com)
+Copyright (c) Sindre Sorhus <sindresorhus@gmail.com> (https://sindresorhus.com)
 
 Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
 

package/package.json

@@ -1,16 +1,22 @@
 {
 	"name": "tempfile",
-	"version": "3.0.0",
+	"version": "5.0.0",
 	"description": "Get a random temporary file path",
 	"license": "MIT",
 	"repository": "sindresorhus/tempfile",
+	"funding": "https://github.com/sponsors/sindresorhus",
 	"author": {
 		"name": "Sindre Sorhus",
 		"email": "sindresorhus@gmail.com",
-		"url": "sindresorhus.com"
+		"url": "https://sindresorhus.com"
+	},
+	"type": "module",
+	"exports": {
+		"types": "./index.d.ts",
+		"default": "./index.js"
 	},
 	"engines": {
-		"node": ">=8"
+		"node": ">=14.18"
 	},
 	"scripts": {
 		"test": "xo && ava && tsd"
@@ -29,12 +35,11 @@
 		"uuid"
 	],
 	"dependencies": {
-		"temp-dir": "^2.0.0",
-		"uuid": "^3.3.2"
+		"temp-dir": "^3.0.0"
 	},
 	"devDependencies": {
-		"ava": "^1.4.1",
-		"tsd": "^0.7.2",
-		"xo": "^0.24.0"
+		"ava": "^5.2.0",
+		"tsd": "^0.25.0",
+		"xo": "^0.53.1"
 	}
 }

package/readme.md

@@ -1,47 +1,49 @@
-# tempfile [![Build Status](https://travis-ci.org/sindresorhus/tempfile.svg?branch=master)](https://travis-ci.org/sindresorhus/tempfile)
+# tempfile
 
 > Get a random temporary file path
 
 **Checkout out [`tempy`](https://github.com/sindresorhus/tempy) which is a better take on this module.**
 
-
 ## Install
 
+```sh
+npm install tempfile
 ```
-$ npm install tempfile
-```
-
 
 ## Usage
 
 ```js
-const tempfile = require('tempfile');
-
-tempfile('.png');
-//=> '/var/folders/3x/jf5977fn79jbglr7rk0tq4d00000gn/T/4049f192-43e7-43b2-98d9-094e6760861b.png'
+import tempfile from 'tempfile';
 
 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
 
 - [tempy](https://github.com/sindresorhus/tempy) - Get a random temporary file or directory path
 - [temp-write](https://github.com/sindresorhus/temp-write) - Write string/buffer/stream to a random temp file
-
-
-## License
-
-MIT © [Sindre Sorhus](https://sindresorhus.com)