@synet/patterns/dist/filesystem/filesystem.d.ts

Robust, battle-tested collection of stable patterns used in Synet packages

export interface FileStats {
    isFile(): boolean;
    isDirectory(): boolean;
    isSymbolicLink(): boolean;
    size: number;
    mtime: Date;
    ctime: Date;
    atime: Date;
    mode: number;
}
/**
 * @deprecated
 * Use @synet/fs instead
 * File system abstraction interface
 */
export interface IFileSystem {
    /**
     * Synchronously check if a file exists
     * @param path Path to check
     */
    existsSync(path: string): boolean;
    /**
     * Read a file as text
     * @param path File path
     */
    readFileSync(path: string): string;
    /**
     * Write text to a file
     * @param path File path
     * @param data Data to write
     */
    writeFileSync(path: string, data: string): void;
    /**
     * Delete a file
     * @param path File path
     */
    deleteFileSync(path: string): void;
    /**
     *  Synchronously delete a directory
     * @param path Directory path
     */
    deleteDirSync(path: string): void;
    /**
     * Read a directory and return its contents
     * @param dirPath Directory path
     */
    readDirSync(dirPath: string): string[];
    /**
     * Ensure a directory exists
     * @param path Directory path
     */
    ensureDirSync(path: string): void;
    /**
     * Set file permissions
     * @param path File path
     * @param mode Permission mode (octal)
     */
    chmodSync(path: string, mode: number): void;
    /**
     * Get file statistics, custom type for flexibility
     * @param path File path
     */
    statSync?(path: string): FileStats;
    /**
     * Clear the contents of a directory (optional)
     * @param dirPath Directory path
     */
    clear?(dirPath: string): void;
}