markmv - v1.26.2
    Preparing search index...

    Class FileUtils

    Utility class for common file system operations.

    Provides a comprehensive set of static methods 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.

    Basic file operations

    // 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);
    Index

    Constructors

    constructor

    Methods

    exists isReadable isWritable getStats ensureDirectory readTextFile writeTextFile copyFile moveFile deleteFile listFiles findMarkdownFiles createBackup getFileSize filesEqual sanitizeFilename getRelativePath

    Constructors

    Methods

    • Check if a file or directory exists

      Parameters

      • path: string

      Returns Promise<boolean>

    • Check if a path is readable

      Parameters

      • path: string

      Returns Promise<boolean>

    • Check if a path is writable

      Parameters

      • path: string

      Returns Promise<boolean>

    • Ensure directory exists, creating it if necessary

      Parameters

      • dirPath: string

      Returns Promise<void>

    • Safely read a file with encoding detection

      Parameters

      • filePath: string

      Returns Promise<string>

    • Safely write a file with directory creation

      Parameters

      • filePath: string
      • content: string
      • options: { createDirectories?: boolean } = {}

      Returns Promise<void>

    • Copy a file with options

      Parameters

      • sourcePath: string
      • destinationPath: string
      • options: CopyOptions = {}

      Returns Promise<void>

    • Move a file with options

      Parameters

      • sourcePath: string
      • destinationPath: string
      • options: MoveOptions = {}

      Returns Promise<void>

    • Delete a file safely

      Parameters

      • filePath: string

      Returns Promise<void>

    • List files in a directory with filtering

      Parameters

      • dirPath: string
      • options: { recursive?: boolean; extensions?: string[]; includeDirectories?: boolean } = {}

      Returns Promise<string[]>

    • Find markdown files in a directory

      Parameters

      • dirPath: string
      • recursive: boolean = true

      Returns Promise<string[]>

    • Create a backup of a file

      Parameters

      • filePath: string
      • suffix: string = '.backup'

      Returns Promise<string>

    • Get file size in bytes

      Parameters

      • filePath: string

      Returns Promise<number>

    • Check if two files have the same content

      Parameters

      • path1: string
      • path2: string

      Returns Promise<boolean>

    • Generate a safe filename by removing invalid characters

      Parameters

      • filename: string

      Returns string

    • Get relative path between two files

      Parameters

      • fromFile: string
      • toFile: string

      Returns string

    Settings

    Member Visibility

    On This Page

    Constructors
    Methods