tempy

temporaryDirectory: (options?: DirectoryOptions) => string;

temporaryDirectoryTask: <ReturnValueType>(
    callback: TaskCallback<ReturnValueType>,
    options?: DirectoryOptions
) => Promise<ReturnValueType>;

temporaryFile: (options?: FileOptions) => string;

temporaryFileTask: <ReturnValueType>(
    callback: TaskCallback<ReturnValueType>,
    options?: FileOptions
) => Promise<ReturnValueType>;

temporaryWrite: (
    fileContent: string | Buffer | TypedArray | DataView | NodeJS.ReadableStream,
    options?: FileOptions
) => Promise<string>;

temporaryWriteSync: (
    fileContent: string | Buffer | TypedArray | DataView,
    options?: FileOptions
) => string;

temporaryWriteTask: <ReturnValueType>(
    fileContent: string | Buffer | TypedArray | DataView | NodeJS.ReadableStream,
    callback: TaskCallback<ReturnValueType>,
    options?: FileOptions
) => Promise<ReturnValueType>;

type BaseOptions = {
    /**
	The name of a directory inside the OS temporary directory to create the temporary file or directory in. The directory is created automatically if it doesn't exist.

	By default, temporary files and directories are created directly inside the OS temporary directory. This option lets you group related temporary files into a subdirectory.

	Useful for organizing temporary files by app or task, making cleanup and debugging easier.

	@example
	```
	import {temporaryFile} from 'tempy';

	temporaryFile({parentDirectory: 'my-app'});
	//=> '/private/var/folders/3x/jf5977fn79jbglr7rk0tq4d00000gn/T/my-app/4f504b9edb5ba0e89451617bf9f971dd'
	```
	*/
    readonly parentDirectory?: string;

    /**
	An absolute path to use as the base directory for temporary files and directories, instead of the OS temporary directory.

	_You usually won't need this option. Prefer the `parentDirectory` option instead._

	This is useful for niche use-cases like different filesystem mounts or journaling filesystems.

	The directory is created automatically if it doesn't exist.

	@example
	```
	import {temporaryFile} from 'tempy';

	temporaryFile({rootDirectory: '/mnt/fast-storage/tmp'});
	//=> '/mnt/fast-storage/tmp/4f504b9edb5ba0e89451617bf9f971dd'
	```
	*/
    readonly rootDirectory?: string;
};

type DirectoryOptions = {
    /**
	Directory prefix.

	_You usually won't need this option. Specify it only when actually needed._

	Useful for testing by making it easier to identify cache directories that are created.
	*/
    readonly prefix?: string;
} & BaseOptions;

type FileOptions = MergeExclusive<
    {
        /**
	File extension.

	Mutually exclusive with the `name` option.

	_You usually won't need this option. Specify it only when actually needed._
	*/
        readonly extension?: string;
    },
    {
        /**
	Filename.

	Mutually exclusive with the `extension` option.

	_You usually won't need this option. Specify it only when actually needed._
	*/
        readonly name?: string;
    }
> &
    BaseOptions;

type TaskCallback<ReturnValueType> = (
    temporaryPath: string
) => Promise<ReturnValueType> | ReturnValueType;