Skip to content
This repository was archived by the owner on Feb 25, 2026. It is now read-only.

Latest commit

 

History

History
23 lines (16 loc) · 1.27 KB

File metadata and controls

23 lines (16 loc) · 1.27 KB

secure-remove

NPM Package Build Status JavaScript Style Guide

API

secureRemove(file[, options])

Securely remove a file, using a pure JS implementation.

  • file (String) - Filepath to securely remove
  • options (Object)
    • iterations (Number) - Overwrite the contents N times instead of the default (3).
    • randomSource (String) - Filename to read random bytes from (i.e. /dev/urandom). By default, crypto.randomBytes() is used as the source of random data.
    • size (String|Number) - Shred this many bytes (suffixes like K, M, G accepted). By default, all of the file is shredded.
    • remove (Boolean) - Truncate and remove file after overwriting. Default false.
    • zero (Boolean) - Add a final overwrite with zeros to hide shredding. Default false.

LICENSE

MIT