bconnorwhiteremove-file-safe
Remove files without try catch.
If I should maintain this repo, please ⭐️
DM me on Twitter if you have questions or suggestions.
Remove files without try catch.
- Returns
trueif file no longer exists.- Returns
falseif unable to remove file.- Returns
undefinedon other errors (ex: permission denied) rather than throwing.
Unless the unsafe flag is set, only files inside the current working directory or OS temp directory will be removed.
Installation
yarn add remove-file-safe
npm install remove-file-safe
pnpm add remove-file-safe
Usage
import { removeFile, removeFileSync, Options } from "remove-file-safe";
function removeFile(path: string, options?: Options): Promise<boolean | undefined>;
function removeFileSync(path: string, options?: Options): boolean | undefined;
type Options = {
/**
* Allow removals outside of current working directory, or OS temp directory. Default: `false`
*/
unsafe?: boolean;
};
Dependencies
- is-path-inside: Check if a path is inside another path
Dev Dependencies
- @types/mock-fs: TypeScript definitions for mock-fs
- @types/node: TypeScript definitions for Node.js
- autorepo: Autorepo abstracts away your dev dependencies, providing a single command to run all of your scripts.
- mock-fs: A configurable mock file system. You know, for testing.
License 
Related Packages
- fs-safe: A simple fs wrapper that doesn't throw
- read-file-safe: Read files without try catch
- write-file-safe: Write files, and parent directories if necessary
- read-dir-safe: Read directories recursively or non-recursively
- write-dir-safe: Create directories and their parents recursively
- remove-dir-safe: Remove directories recursively or non-recursively