Neurotic and Probably Misinformed
Learn about our RFC process, Open RFC meetings & more.Join in the discussion! »

filename-temp-track

2.0.2 • Public • Published

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

or

yarn filename-temp-track

Use

track(filename, cleanupTimeout, inDirectory)

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

  • filename: string with the file name. If inDirectory is false, this is the full path of the file to track. It can also be an object with all the same properties as the method signature (see second example below)
  • cleanuptimeout: number in ms after which to delete the file
  • inDirectory: boolean (default true)
  • Returns a Promise with the full path name, including the base temporary directory.

Example 1:

// 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 2:

// 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)

getFilesBeingTracked()

Returns the array of files being tracked

History

2.0.0

  • Refactor into Class
  • Adds inDirectory optional parameter

1.0.0

  • Initial version

Contributors

License

MIT - Copyright (c) 2017, 2019 - Luis Lobo Borobia luislobo@gmail.com

Install

npm i filename-temp-track

DownloadsWeekly Downloads

9

Version

2.0.2

License

MIT

Unpacked Size

43.8 kB

Total Files

16

Last publish

Collaborators

  • avatar