kist
Version:
Package Pipeline Processor
31 lines (30 loc) • 1.12 kB
TypeScript
import { Action } from "../../core/pipeline/Action";
import { ActionOptionsType } from "../../types/ActionOptionsType";
/**
* FileRenameAction handles renaming files within the file system.
* Ensures that file renaming operations are handled efficiently and safely.
*/
export declare class FileRenameAction extends Action {
/**
* Executes the file renaming action.
*
* @param options - The options specifying the source and target file paths.
* @returns A Promise that resolves when the file has been successfully renamed.
* @throws {Error} If the source file does not exist or cannot be renamed.
*/
execute(options: ActionOptionsType): Promise<void>;
/**
* Renames a file from its current path to a new path.
*
* @param srcPath - The current file path.
* @param targetPath - The new file path.
* @returns A Promise that resolves once the file is successfully renamed.
*/
private renameFile;
/**
* Provides a description of the action.
*
* @returns A string description of the action.
*/
describe(): string;
}