Skip to content
Get a random temporary file or directory path
JavaScript TypeScript
Branch: master
Clone or download

Latest commit

Latest commit 37229ce Apr 16, 2020

Files

Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.github Create funding.yml May 28, 2019
.editorconfig Meta tweaks Sep 13, 2017
.gitattributes Require Node.js 6 Oct 26, 2018
.gitignore Meta tweaks Sep 13, 2017
.npmrc Meta tweaks Sep 13, 2017
.travis.yml Require Node.js 10 Feb 12, 2020
index.d.ts Add methods for writing data to temp files (#22) Mar 9, 2020
index.js Add methods for writing data to temp files (#22) Mar 9, 2020
index.test-d.ts Meta tweaks Apr 16, 2020
license Meta tweaks Mar 9, 2020
package.json 0.5.0 Mar 9, 2020
readme.md Add methods for writing data to temp files (#22) Mar 9, 2020
test.js Add methods for writing data to temp files (#22) Mar 9, 2020

readme.md

tempy Build Status

Get a random temporary file or directory path

Install

$ npm install tempy

Usage

const 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'

API

tempy.file(options?)

Get a temporary file path you can write to.

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.

tempy.directory()

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

tempy.write(fileContent, options?)

Write data to a random temp file.

fileContent

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

Data to write to the temp file.

options

See options.

tempy.writeSync(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.

tempy.root

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

FAQ

Why doesn't it have a cleanup method?

Temp files will be periodically cleaned up on macOS. Most Linux distros will clean up on reboot. If you're generating a lot of temp files, it's recommended to use a complementary module like del for cleanup.

You can’t perform that action at this time.