tempy/readme.md

Get a random temporary file or directory path

# tempy

> Get a random temporary file or directory path

## Install

```sh
npm install tempy
```

## Usage

```js
import {temporaryFile, temporaryDirectory} from 'tempy';

temporaryFile();
//=> '/private/var/folders/3x/jf5977fn79jbglr7rk0tq4d00000gn/T/4f504b9edb5ba0e89451617bf9f971dd'

temporaryFile({extension: 'png'});
//=> '/private/var/folders/3x/jf5977fn79jbglr7rk0tq4d00000gn/T/a9fb0decd08179eb6cf4691568aa2018.png'

temporaryFile({name: 'unicorn.png'});
//=> '/private/var/folders/3x/jf5977fn79jbglr7rk0tq4d00000gn/T/f7f62bfd4e2a05f1589947647ed3f9ec/unicorn.png'

temporaryDirectory();
//=> '/private/var/folders/3x/jf5977fn79jbglr7rk0tq4d00000gn/T/2f3d094aec2cb1b93bb0f4cffce5ebd6'

temporaryDirectory({prefix: 'name'});
//=> '/private/var/folders/3x/jf5977fn79jbglr7rk0tq4d00000gn/T/name_3c085674ad31223b9653c88f725d6b41'
```

## API

### temporaryFile(options?)

Get a temporary file path you can write to.

### temporaryFileTask(callback, options?)

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 with the return value of the callback after it is executed and the file is cleaned up.

#### callback

Type: `(tempPath: string) => void`

A callback that is executed with the temp file path. Can be asynchronous.

#### options

Type: `object`

*You usually won't need either the `extension` or `name` option. Specify them only when actually needed.*

##### extension

Type: `string`

File extension.

##### name

Type: `string`

Filename. Mutually exclusive with the `extension` option.

##### parentDirectory

Type: `string`

The name of a directory inside the OS temporary directory to create the temporary file in. The directory is created automatically if it doesn't exist.

By default, the temporary file is 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.

```js
import {temporaryFile} from 'tempy';

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

##### rootDirectory

Type: `string`

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

*You usually won't need this option. Prefer the `parentDirectory` option instead.*

Useful for niche use-cases like different filesystem mounts or journaling filesystems. The directory is created automatically if it doesn't exist.

```js
import {temporaryFile} from 'tempy';

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

### temporaryDirectory(options?)

Get a temporary directory path. The directory is created for you.

### temporaryDirectoryTask(callback, options?)

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 with the return value of the callback after it is executed and the directory is cleaned up.

##### callback

Type: `(tempPath: string) => void`

A callback that is executed with the temp directory path. Can be asynchronous.

#### options

Type: `Object`

##### prefix

Type: `string`

Directory prefix.

Useful for testing by making it easier to identify cache directories that are created.

*You usually won't need this option. Specify it only when actually needed.*

##### parentDirectory

Type: `string`

The name of a directory inside the OS temporary directory to create the temporary directory in. The directory is created automatically if it doesn't exist.

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

```js
import {temporaryDirectory} from 'tempy';

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

##### rootDirectory

Type: `string`

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

*You usually won't need this option. Prefer the `parentDirectory` option instead.*

Useful for niche use-cases like different filesystem mounts or journaling filesystems. The directory is created automatically if it doesn't exist.

```js
import {temporaryDirectory} from 'tempy';

temporaryDirectory({rootDirectory: '/mnt/fast-storage/tmp'});
//=> '/mnt/fast-storage/tmp/2f3d094aec2cb1b93bb0f4cffce5ebd6'
```

### temporaryWrite(fileContent, options?)

Write data to a random temp file.

### temporaryWriteTask(fileContent, callback, options?)

Write data to a random temp file. The file is automatically cleaned up after the callback is executed. Returns a promise that resolves with the return value of the callback after it is executed and the file is cleaned up.

##### fileContent

Type: `string | Buffer | TypedArray | DataView | stream.Readable`

Data to write to the temp file.

##### callback

Type: `(tempPath: string) => void`

A callback that is executed with the temp file path. Can be asynchronous.

##### options

See [options](#options).

### temporaryWriteSync(fileContent, options?)

Synchronously write data to a random temp file.

##### fileContent

Type: `string | Buffer | TypedArray | DataView`

Data to write to the temp file.

##### options

See [options](#options).

### rootTemporaryDirectory

Get the root temporary directory path. For example: `/private/var/folders/3x/jf5977fn79jbglr7rk0tq4d00000gn/T`