markmv - v1.39.2
    Preparing search index...

    Variable FileUtilsConst

    FileUtils: {
        exists: (path: string) => Promise<boolean>;
        isReadable: (path: string) => Promise<boolean>;
        isWritable: (path: string) => Promise<boolean>;
        getStats: (path: string) => Promise<FileStats>;
        ensureDirectory: (dirPath: string) => Promise<void>;
        readTextFile: (filePath: string) => Promise<string>;
        writeTextFile: (
            filePath: string,
            content: string,
            options?: { createDirectories?: boolean },
        ) => Promise<void>;
        copyFile: (
            sourcePath: string,
            destinationPath: string,
            options?: CopyOptions,
        ) => Promise<void>;
        moveFile: (
            sourcePath: string,
            destinationPath: string,
            options?: MoveOptions,
        ) => Promise<void>;
        deleteFile: (filePath: string) => Promise<void>;
        listFiles: (
            dirPath: string,
            options?: {
                recursive?: boolean;
                extensions?: string[];
                includeDirectories?: boolean;
            },
        ) => Promise<string[]>;
        findMarkdownFiles: (
            dirPath: string,
            recursive?: boolean,
        ) => Promise<string[]>;
        createBackup: (filePath: string, suffix?: string) => Promise<string>;
        getFileSize: (filePath: string) => Promise<number>;
        filesEqual: (path1: string, path2: string) => Promise<boolean>;
        sanitizeFilename: (filename: string) => string;
        getRelativePath: (fromFile: string, toFile: string) => string;
    } = ...

    Utility namespace for common file system operations.

    Provides a comprehensive set of functions for file and directory manipulation, with proper error handling and cross-platform compatibility. All methods are async and use Node.js promises-based file system APIs.

    Type Declaration

    • exists: (path: string) => Promise<boolean>
    • isReadable: (path: string) => Promise<boolean>
    • isWritable: (path: string) => Promise<boolean>
    • getStats: (path: string) => Promise<FileStats>
    • ensureDirectory: (dirPath: string) => Promise<void>
    • readTextFile: (filePath: string) => Promise<string>
    • writeTextFile: (
          filePath: string,
          content: string,
          options?: { createDirectories?: boolean },
      ) => Promise<void>
    • copyFile: (
          sourcePath: string,
          destinationPath: string,
          options?: CopyOptions,
      ) => Promise<void>
    • moveFile: (
          sourcePath: string,
          destinationPath: string,
          options?: MoveOptions,
      ) => Promise<void>
    • deleteFile: (filePath: string) => Promise<void>
    • listFiles: (
          dirPath: string,
          options?: {
              recursive?: boolean;
              extensions?: string[];
              includeDirectories?: boolean;
          },
      ) => Promise<string[]>
    • findMarkdownFiles: (dirPath: string, recursive?: boolean) => Promise<string[]>
    • createBackup: (filePath: string, suffix?: string) => Promise<string>
    • getFileSize: (filePath: string) => Promise<number>
    • filesEqual: (path1: string, path2: string) => Promise<boolean>
    • sanitizeFilename: (filename: string) => string
    • getRelativePath: (fromFile: string, toFile: string) => string
    Basic file operations ```typescript // Check if file exists const exists = await FileUtils.exists('document.md');

      // Read file content const content = await FileUtils.readTextFile('document.md');

      // Write new content await FileUtils.writeTextFile('output.md', content, { createDirectories: true });

      // Find markdown files const files = await FileUtils.findMarkdownFiles('./docs', true); ```

    Settings
    Member Visibility