create-temp-file

v0.4.0
Creates a temporary file, returns a write stream, a path, and cleanup functions
stream temp tmp write

create-temp-file

A tiny node module that creates a temporary file, returns a write stream, a path, and cleanup functions

Build Status

example

var createTempFile = require('create-temp-file')

var ws = createTempFile()
process.stdin.pipe(ws)

process.on('exit', ws.cleanupSync)

api

var createTempFile = require('create-temp-file')

var ws = createTempFile([extension])

You can set the file extension for the temp file, or don't set an extension. E.g. '.png'.

ws is a write stream to the new temporary file with the following properties:

  • ws.path is the absolute path to the temporary file. E.g. '/tmp/b285e724-226c-11e5-9981-82bd40254040.png'
  • ws.cleanup([cb]) deletes the temporary file. Like fs.unlink
  • ws.cleanupSync deletes the temporary file synchronously. Like fs.unlinkSync

If an error occurs in ws.cleanup() or ws.cleanupSync(), the error will be emitted. Catch any errors like this:

ws.on('error', function (e) {
    throw e
})

install

With npm do:

npm install create-temp-file

license

VOL

Metadata

  • VOL
  • Whatever
  • Joseph Dykstra
  • released 7/9/2015

Downloads

Maintainers