import { LyraProcedureMethodNode } from './index';
export declare enum EFileSystemPathType {
    AP = "ap",
    Usr = "usr",
    Temp = "temp"
}
export interface IPathOptions {
    path: string;
    pathType: EFileSystemPathType;
}
export interface IFileStat {
    filePath: string;
    size: number;
    createTime: number;
}
export interface IReadFileOptions extends IPathOptions {
    encoding?: string;
}
export interface IReadFileSuccess {
    data: any;
}
export interface IWriteFileOptions extends IPathOptions {
    data: string;
    encoding?: string;
}
export interface IRenameOptions {
    srcPath: IPathOptions;
    distPath: IPathOptions;
}
export interface IMakeDirOptions extends IPathOptions {
    recursive?: boolean;
}
export interface IFileSystemProcedure {
    /**
     * 判断文件/目录是否存在
     * @param path 文件相对路径
     * @param pathType 虚拟路径类型
     */
    exists: LyraProcedureMethodNode<IPathOptions, boolean>;
    /**
     * 读取文件内容
     * @param path 文件相对路径
     * @param pathType 虚拟路径类型
     * @param encoding 编码
     */
    readFile: LyraProcedureMethodNode<IReadFileOptions, IReadFileSuccess>;
    /**
     * 写入文件
     * @param path 文件相对路径
     * @param pathType 虚拟路径类型
     * @param data 写入的数据
     * @param encoding 编码
     */
    writeFile: LyraProcedureMethodNode<IWriteFileOptions, null>;
    /**
     * 在文件结尾追加内容
     * @param path 文件相对路径
     * @param pathType 虚拟路径类型
     * @param data 追加内容
     * @param encoding 编码
     */
    appendFile: LyraProcedureMethodNode<IWriteFileOptions, null>;
    /**
     * 重命名/移动文件，可以把文件从 `srcPath` 移动到 `srcPath`
     * @param srcPath 文件路径选项 (path/pathType)
     * @param distPath 目标路径选项 (path/pathType)
     */
    rename: LyraProcedureMethodNode<IRenameOptions, null>;
    /**
     * 读取目录内文件列表
     * @param path 目录相对路径
     * @param pathType 虚拟路径类型
     */
    readdir: LyraProcedureMethodNode<IPathOptions, string[]>;
    /**
     * 获取文件 Stats
     * @param path 文件相对路径
     * @param pathType 虚拟路径类型
     */
    stat: LyraProcedureMethodNode<IPathOptions, IFileStat>;
    /**
     * 删除文件/文件夹
     * @param path 文件相对路径
     * @param pathType 虚拟路径类型
     */
    remove: LyraProcedureMethodNode<IPathOptions, null>;
    /**
     * 创建目录
     * @param path 目录相对路径
     * @param pathType 虚拟路径类型
     * @param recursive 是否递归创建
     */
    mkdir: LyraProcedureMethodNode<IMakeDirOptions, null>;
    /**
     * 文件是否是软连接
     * @param path 文件相对路径
     * @param pathType 虚拟路径类型
     */
    isSymbolicLink: LyraProcedureMethodNode<IPathOptions, boolean>;
    /**
     * 获取文件的 md5 hash
     * @param path 文件相对路径
     * @param pathType 虚拟路径类型
     */
    getFileMd5: LyraProcedureMethodNode<IPathOptions, string>;
}
//# sourceMappingURL=fs.d.ts.map