Package Exports

filename-temp-track

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 (filename-temp-track) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

File name tracking in temporary directory and auto clean up

Keeps track of filenames, saved in a temporary folder, and automatically cleans up by default in an hour

Useful when receiving files being uploaded, or downloaded, that needs to be cleaned up after some time or when the process exits

Install

npm install filename-temp-track

yarn filename-temp-track

Use

The library exposes the following functions: track, cleanupFile, cleanupFileSync, cleanupAll, cleanupAllSync and getBaseDirectory:

track(filename|opts)

Tracks a filename, under a temporary folder, and deletes it after an hour, by default.

filename|opts: It accepts a filename or an object with options. Options could be filename with the filename, and cleanupTimeout with a cleanup timeout in milliseconds.
Returns a Promise with the full path name, including the base temporary directory.

Example:

// Tracks for a filename, using the default timeout of an hour
ft.track('filename.xls')
  .then(function(pathName){ // pathName should be /tmp/sometemp/filename.xls});

Example:

// Tracks for a filename, using a custom timeout of a minute
ft.track({filename: 'filename.xls', cleanupTimeout: 1000 * 60})
  .then(function(pathName){ // pathName should be /tmp/sometemp/filename.xls});

cleanupFile(pathname)

Cleans up the pathname

pathname: is the full path name of the file to cleaned up
Returns a Promise

cleanupFileSync(pathname)

Cleans up the pathname (sync version)

pathname: is the full path name of the file to cleaned up
Returns undefined

cleanupAll()

Cleans up all the files being controlled by this module

cleanupAllSync()

Cleans up all the files being controlled by this module (sync version)

getBaseDirectory()

Returns the temporary base directory

getFilesBeingTracked()

Returns the array of files being tracked

History

v 1.0.0 - Initial version

filename-temp-track