@thi.ng/file-io/delete.d.ts

Assorted file I/O utils (w/ logging support) for NodeJS/Bun

import type { ILogger } from "@thi.ng/logger";
/**
 * Deletes file at given path. If `dryRun` is true (default: false), the file
 * WON'T be deleted, however if a `logger` is provided then at least a dry-run
 * log message will be emitted.
 *
 * @param path
 * @param logger
 * @param dryRun
 */
export declare const deleteFile: (path: string, logger?: ILogger, dryRun?: boolean) => void;
export declare const deleteFileAsync: (path: string, logger?: ILogger, dryRun?: boolean) => Promise<void>;
/**
 * Deletes multiple files via {@link deleteFile}. Any errors are caught and
 * logged, but ignored otherwise. If `dryRun` is true, files WON'T be deleted.
 *
 * @param paths
 * @param logger
 * @param dryRun
 */
export declare const deleteFiles: (paths: Iterable<string>, logger?: ILogger, dryRun?: boolean) => void;
export declare const deleteFilesAsync: (paths: Iterable<string>, logger?: ILogger, dryRun?: boolean) => Promise<void>;
/**
 * Like {@link deleteFile}, but attempts to recursively remove an entire
 * directory at given path.
 *
 * @param path
 * @param logger
 * @param dryRun
 */
export declare const deleteDir: (path: string, logger?: ILogger, dryRun?: boolean) => void;
//# sourceMappingURL=delete.d.ts.map