@visulima/fs/dist/remove/remove-sync.d.ts

Human friendly file system utilities for Node.js

import type { RetryOptions } from "../types.d.ts";
/**
 * Synchronously removes a file or directory (recursively).
 * If the path does not exist, it does nothing.
 * @param path The path to the file or directory to remove.
 * @param options Optional configuration for the operation. See {@link RetryOptions}.
 * @example
 * ```javascript
 * import { removeSync } from "@visulima/fs";
 * import { join } from "node:path";
 *
 * try {
 *   removeSync(join("/tmp", "my-file.txt"));
 *   console.log("File /tmp/my-file.txt removed.");
 *
 *   removeSync(join("/tmp", "my-empty-dir"));
 *   console.log("Directory /tmp/my-empty-dir removed.");
 *
 *   removeSync(join("/tmp", "my-dir-with-contents"));
 *   console.log("Directory /tmp/my-dir-with-contents and its contents removed.");
 * } catch (error) {
 *   console.error("Failed to remove path:", error);
 * }
 * ```
 */
declare const removeSync: (path: URL | string, options?: RetryOptions) => void;
export default removeSync;