Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/sindresorhus/tempy
Get a random temporary file or directory path
https://github.com/sindresorhus/tempy
Last synced: about 2 months ago
JSON representation
Get a random temporary file or directory path
- Host: GitHub
- URL: https://github.com/sindresorhus/tempy
- Owner: sindresorhus
- License: mit
- Created: 2017-03-28T10:43:22.000Z (over 7 years ago)
- Default Branch: main
- Last Pushed: 2023-07-10T18:24:36.000Z (about 1 year ago)
- Last Synced: 2024-05-22T18:23:35.441Z (4 months ago)
- Language: JavaScript
- Size: 41 KB
- Stars: 412
- Watchers: 7
- Forks: 32
- Open Issues: 6
-
Metadata Files:
- Readme: readme.md
- Funding: .github/funding.yml
- License: license
- Security: .github/security.md
Awesome Lists containing this project
- awesome-nodejs-cn - tempy - 随机获取临时文件或目录的路径 (包 / 文件系统)
- awesome-nodejs - tempy - Get a random temporary file or directory path. 302  (Repository / Filesystem)
- awesome-nodejs-cn - tempy - **star:416** 获取随机临时文件或目录路径 (包 / 文件系统)
- awesome-list - tempy
- awesome-nodejs - tempy - Get a random temporary file or directory path. (Packages / Filesystem)
- awesome-web-dev - tempy
- awesome-node - tempy - Get a random temporary file or directory path. (Packages / Filesystem)
- awesome-nodejs-cn - tempy - 获取随机的临时文件或目录路径. (目录 / 文件系统)
- awesome-nodejs - tempy - 获取随机的临时文件或目录路径 (Uncategorized / Uncategorized)
README
# 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.
### 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.*
### 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`