gather-ts/dist/src/utils/filesystem/interfaces/IFileSystem.d.ts

A powerful code analysis and packaging tool designed for creating AI-friendly code representations for javascript and typescript projects.

/// <reference types="node" />
/// <reference types="node" />
import { IService } from "@/types/services";
import { ILogger } from "@/utils/logging/interfaces/ILogger";
export interface IFileOperationOptions {
    encoding?: BufferEncoding;
    flag?: string;
}
export interface IFileSystemOptions {
    debug?: boolean;
}
export interface IFileSystemDeps {
    logger: ILogger;
}
export interface IFileSystem extends IService {
    resolvePath(...paths: string[]): string;
    joinPath(...paths: string[]): string;
    getRelativePath(from: string, to: string): string;
    getDirName(path: string): string;
    getBaseName(path: string): string;
    getExtension(path: string): string;
    isAbsolute(path: string): boolean;
    dirname(path: string): string;
    basename(path: string): string;
    extname(path: string): string;
    statSync(path: string): {
        mtime: Date;
    };
    readFileSync(filePath: string, encoding?: BufferEncoding): string;
    writeFileSync(filePath: string, data: string | Buffer, options?: IFileOperationOptions): void;
    exists(path: string): boolean;
    isReadable(filePath: string): boolean;
    isWritable(filePath: string): boolean;
    readFile(filePath: string, options?: IFileOperationOptions): Promise<string>;
    writeFile(filePath: string, data: string | Buffer, options?: IFileOperationOptions): Promise<void>;
    deleteFile(filePath: string): Promise<void>;
    createDirectory(dirPath: string, recursive?: boolean): Promise<void>;
    validatePath(filePath: string, checkExists?: boolean): void;
}