JSPM

  • Created
  • Published
  • Downloads 50665830
  • Score
    100M100P100Q235510F

Temporary file and directory creator

Package Exports

  • tmp

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (tmp) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

Tmp

A simple temporary file and directory creator for node.js.

About

The main difference between bruce's node-temp is that that mine more aggressively checks for the exitence of the newly created temporary file.

The API is slightly different, mine does not yet provide synchronous calls and all the parameters are optional. And you can even set whether you want to remove the temporary file on process exit or not.

How to install

npm install tmp

Usage

File creation

var tmp = require('tmp');

tmp.file(function _tempFileCreated(err, path, fd) {
  if (err) throw err;

  console.log("File: ", path);
  console.log("Filedescriptor: ", fd);
});

Directory creation

var tmp = require('tmp');

tmp.dir(function _tempDirCreated(err, path) {
  if (err) throw err;

  console.log("Dir: ", path);
});

Advanced usage

File creation

var tmp = require('tmp');

tmp.file({ mode: 0644, prefix: 'prefix-', postfix: '.txt' }, function _tempFileCreated(err, path, fd) {
  if (err) throw err;

  console.log("File: ", path);
  console.log("Filedescriptor: ", fd);
});

Directory creation

tmp.dir({ mode: 0750, prefix: 'myTmpDir_' }, function _tempDirCreated(err, path) {
  if (err) throw err;

  console.log("Dir: ", path);
});

mkstemps like

tmp.dir({ template: '/tmp/tmp-XXXXXX' }, function _tempDirCreated(err, path) {
  iff (err) throw err;

  console.log("Dir: ", path);
});

Options

All options are optional :)

  • mode: the file mode to create with it fallbacks to 0600 on file creation and 0700 on directory creation
  • prefix: the optional prefix, fallback to tmp- if not provided
  • postfix: the optional postfix, fallbacks to .tmp on file creation
  • template: mkstemps like filename template, no default
  • dir: the optional temporary directory, fallbacks to system default (guesses from environment)
  • tries: how many times should the function tries to get a unique filename before giving up, default 3