.github/workflows/main.yml

@@ -0,0 +1,20 @@
+name: CI
+on:
+  - push
+  - pull_request
+jobs:
+  test:
+    name: Node.js ${{ matrix.node-version }}
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        node-version:
+          - 16
+    steps:
+      - uses: actions/checkout@v3
+      - uses: actions/setup-node@v3
+        with:
+          node-version: ${{ matrix.node-version }}
+      - run: npm install
+      - run: npm test

index.d.ts

@@ -1,173 +1,156 @@
-/// <reference types="node"/>
+import {Buffer} from 'node:buffer';
 import {MergeExclusive, TypedArray} from 'type-fest';
 
-declare namespace tempy {
-	type FileOptions = MergeExclusive<
-	{
-		/**
-			File extension.
-
-			Mutually exclusive with the `name` option.
+export type FileOptions = MergeExclusive<
+{
+	/**
+	File extension.
 
-			_You usually won't need this option. Specify it only when actually needed._
-			*/
-		readonly extension?: string;
-	},
-	{
-		/**
-			Filename.
+	Mutually exclusive with the `name` option.
 
-			Mutually exclusive with the `extension` option.
+	_You usually won't need this option. Specify it only when actually needed._
+	*/
+	readonly extension?: string;
+},
+{
+	/**
+	Filename.
 
-			_You usually won't need this option. Specify it only when actually needed._
-			*/
-		readonly name?: string;
-	}
-	>;
+	Mutually exclusive with the `extension` option.
 
-	type DirectoryOptions = {
-		/**
-		_You usually won't need this option. Specify it only when actually needed._
+	_You usually won't need this option. Specify it only when actually needed._
+	*/
+	readonly name?: string;
+}
+>;
 
-		Directory prefix.
+export type DirectoryOptions = {
+	/**
+	Directory prefix.
 
-		Useful for testing by making it easier to identify cache directories that are created.
-		*/
-		readonly prefix?: string;
-	};
+	_You usually won't need this option. Specify it only when actually needed._
 
-	/**
-	The temporary path created by the function. Can be asynchronous.
+	Useful for testing by making it easier to identify cache directories that are created.
 	*/
-	type TaskCallback = (tempPath: string) => Promise<void> | void;
-}
+	readonly prefix?: string;
+};
 
-declare const tempy: {
-	file: {
-		/**
-		The `callback` resolves with a temporary file path you can write to. The file is automatically cleaned up after the callback is executed.
-
-		@returns A promise that resolves after the callback is executed and the file is cleaned up.
-
-		@example
-		```
-		import tempy = require('tempy');
-
-		await tempy.file.task(tempFile => {
-			console.log(tempFile);
-			//=> '/private/var/folders/3x/jf5977fn79jbglr7rk0tq4d00000gn/T/4f504b9edb5ba0e89451617bf9f971dd'
-		});
-		```
-		*/
-		task: (callback: tempy.TaskCallback, options?: tempy.FileOptions) => Promise<void>;
-
-		/**
-		Get a temporary file path you can write to.
-
-		@example
-		```
-		import tempy = require('tempy');
-
-		tempy.file();
-		//=> '/private/var/folders/3x/jf5977fn79jbglr7rk0tq4d00000gn/T/4f504b9edb5ba0e89451617bf9f971dd'
-
-		tempy.file({extension: 'png'});
-		//=> '/private/var/folders/3x/jf5977fn79jbglr7rk0tq4d00000gn/T/a9fb0decd08179eb6cf4691568aa2018.png'
-
-		tempy.file({name: 'unicorn.png'});
-		//=> '/private/var/folders/3x/jf5977fn79jbglr7rk0tq4d00000gn/T/f7f62bfd4e2a05f1589947647ed3f9ec/unicorn.png'
-
-		tempy.directory();
-		//=> '/private/var/folders/3x/jf5977fn79jbglr7rk0tq4d00000gn/T/2f3d094aec2cb1b93bb0f4cffce5ebd6'
-		```
-		*/
-		(options?: tempy.FileOptions): string;
-	};
-
-	directory: {
-		/**
-		The `callback` resolves with a temporary directory path you can write to. The directory is automatically cleaned up after the callback is executed.
-
-		@returns A promise that resolves after the callback is executed and the directory is cleaned up.
-
-		@example
-		```
-		import tempy = require('tempy');
-
-		await tempy.directory.task(tempDirectory => {
-			//=> '/private/var/folders/3x/jf5977fn79jbglr7rk0tq4d00000gn/T/2f3d094aec2cb1b93bb0f4cffce5ebd6'
-		})
-		```
-		*/
-		task: (callback: tempy.TaskCallback, options?: tempy.DirectoryOptions) => Promise<void>;
-
-		/**
-		Get a temporary directory path. The directory is created for you.
-
-		@example
-		```
-		import tempy = require('tempy');
-
-		tempy.directory();
-		//=> '/private/var/folders/3x/jf5977fn79jbglr7rk0tq4d00000gn/T/2f3d094aec2cb1b93bb0f4cffce5ebd6'
-
-		tempy.directory({prefix: 'a'});
-		//=> '/private/var/folders/3x/jf5977fn79jbglr7rk0tq4d00000gn/T/name_3c085674ad31223b9653c88f725d6b41'
-		```
-		*/
-		(options?: tempy.DirectoryOptions): string;
-	};
-
-	write: {
-		/**
-		Write data to a random temp file. The file is automatically cleaned up after the callback is executed.
-
-		@returns A promise that resolves after the callback is executed and the file is cleaned up.
-
-		@example
-		```
-		import tempy = require('tempy');
-
-		await tempy.write.task('🦄', tempFile => {
-			//=> '/private/var/folders/3x/jf5977fn79jbglr7rk0tq4d00000gn/T/4f504b9edb5ba0e89451617bf9f971dd'
-		});
-		```
-		*/
-		task: (fileContent: string | Buffer | TypedArray | DataView | NodeJS.ReadableStream, callback: tempy.TaskCallback, options?: tempy.FileOptions) => Promise<void>;
-
-		/**
-		Write data to a random temp file.
-
-		@example
-		```
-		import tempy = require('tempy');
-
-		await tempy.write('🦄');
-		//=> '/private/var/folders/3x/jf5977fn79jbglr7rk0tq4d00000gn/T/2f3d094aec2cb1b93bb0f4cffce5ebd6'
-		```
-		*/
-		(fileContent: string | Buffer | TypedArray | DataView | NodeJS.ReadableStream, options?: tempy.FileOptions): Promise<string>;
-	};
+/**
+The temporary path created by the function. Can be asynchronous.
+*/
+export type TaskCallback<ReturnValueType> = (temporaryPath: string) => Promise<ReturnValueType> | ReturnValueType;
 
-	/**
-	Synchronously write data to a random temp file.
+/**
+Get a temporary file path you can write to.
 
-	@example
-	```
-	import tempy = require('tempy');
+@example
+```
+import {temporaryFile, temporaryDirectory} from 'tempy';
 
-	tempy.writeSync('🦄');
-	//=> '/private/var/folders/3x/jf5977fn79jbglr7rk0tq4d00000gn/T/2f3d094aec2cb1b93bb0f4cffce5ebd6'
-	```
-	*/
-	writeSync: (fileContent: string | Buffer | TypedArray | DataView, options?: tempy.FileOptions) => string;
+temporaryFile();
+//=> '/private/var/folders/3x/jf5977fn79jbglr7rk0tq4d00000gn/T/4f504b9edb5ba0e89451617bf9f971dd'
 
-	/**
-	Get the root temporary directory path.
+temporaryFile({extension: 'png'});
+//=> '/private/var/folders/3x/jf5977fn79jbglr7rk0tq4d00000gn/T/a9fb0decd08179eb6cf4691568aa2018.png'
 
-	For example: `/private/var/folders/3x/jf5977fn79jbglr7rk0tq4d00000gn/T`.
-	*/
-	readonly root: string;
-};
+temporaryFile({name: 'unicorn.png'});
+//=> '/private/var/folders/3x/jf5977fn79jbglr7rk0tq4d00000gn/T/f7f62bfd4e2a05f1589947647ed3f9ec/unicorn.png'
+
+temporaryDirectory();
+//=> '/private/var/folders/3x/jf5977fn79jbglr7rk0tq4d00000gn/T/2f3d094aec2cb1b93bb0f4cffce5ebd6'
+```
+*/
+export function temporaryFile(options?: FileOptions): string;
+
+/**
+The `callback` resolves with a temporary file path you can write to. The file is automatically cleaned up after the callback is executed.
+
+@returns A promise that resolves after the callback is executed and the file is cleaned up.
+
+@example
+```
+import {temporaryFileTask} from 'tempy';
+
+await temporaryFileTask(tempFile => {
+	console.log(tempFile);
+	//=> '/private/var/folders/3x/jf5977fn79jbglr7rk0tq4d00000gn/T/4f504b9edb5ba0e89451617bf9f971dd'
+});
+```
+*/
+export function temporaryFileTask<ReturnValueType>(callback: TaskCallback<ReturnValueType>, options?: FileOptions): Promise <ReturnValueType>;
+
+/**
+Get a temporary directory path. The directory is created for you.
 
-export = tempy;
+@example
+```
+import {temporaryDirectory} from 'tempy';
+
+temporaryDirectory();
+//=> '/private/var/folders/3x/jf5977fn79jbglr7rk0tq4d00000gn/T/2f3d094aec2cb1b93bb0f4cffce5ebd6'
+
+temporaryDirectory({prefix: 'a'});
+//=> '/private/var/folders/3x/jf5977fn79jbglr7rk0tq4d00000gn/T/name_3c085674ad31223b9653c88f725d6b41'
+```
+*/
+export function temporaryDirectory(options?: DirectoryOptions): string;
+
+/**
+The `callback` resolves with a temporary directory path you can write to. The directory is automatically cleaned up after the callback is executed.
+
+@returns A promise that resolves after the callback is executed and the directory is cleaned up.
+
+@example
+```
+import {temporaryDirectoryTask} from 'tempy';
+
+await temporaryDirectoryTask(tempDirectory => {
+	//=> '/private/var/folders/3x/jf5977fn79jbglr7rk0tq4d00000gn/T/2f3d094aec2cb1b93bb0f4cffce5ebd6'
+})
+```
+*/
+export function temporaryDirectoryTask<ReturnValueType>(callback: TaskCallback<ReturnValueType>, options?: DirectoryOptions): Promise<ReturnValueType>;
+
+/**
+Write data to a random temp file.
+
+@example
+```
+import {temporaryWrite} from 'tempy';
+
+await temporaryWrite('🦄');
+//=> '/private/var/folders/3x/jf5977fn79jbglr7rk0tq4d00000gn/T/2f3d094aec2cb1b93bb0f4cffce5ebd6'
+```
+*/
+export function temporaryWrite(fileContent: string | Buffer | TypedArray | DataView | NodeJS.ReadableStream, options?: FileOptions): Promise<string>;
+
+/**
+Write data to a random temp file. The file is automatically cleaned up after the callback is executed.
+
+@returns A promise that resolves after the callback is executed and the file is cleaned up.
+
+@example
+```
+import {temporaryWriteTask} from 'tempy';
+
+await temporaryWriteTask('🦄', tempFile => {
+	//=> '/private/var/folders/3x/jf5977fn79jbglr7rk0tq4d00000gn/T/4f504b9edb5ba0e89451617bf9f971dd'
+});
+```
+*/
+export function temporaryWriteTask<ReturnValueType>(fileContent: string | Buffer | TypedArray | DataView | NodeJS.ReadableStream, callback: TaskCallback<ReturnValueType>, options?: FileOptions): Promise<ReturnValueType>;
+
+/**
+Synchronously write data to a random temp file.
+
+@example
+```
+import {temporaryWriteSync} from 'tempy';
+
+temporaryWriteSync('🦄');
+//=> '/private/var/folders/3x/jf5977fn79jbglr7rk0tq4d00000gn/T/2f3d094aec2cb1b93bb0f4cffce5ebd6'
+```
+*/
+export function temporaryWriteSync(fileContent: string | Buffer | TypedArray | DataView, options?: FileOptions): string;
+
+export {default as rootTemporaryDirectory} from 'temp-dir';