fileRename

Category: File Operations

Namespace: web.files.fileRename

Description

Renames or moves a file from one path to another. Can be used to rename files in the same directory or move files to different directories.

Syntax

const success = await web.files.fileRename({
    oldFileName: 'path/to/old_name.txt',
    newFileName: 'path/to/new_name.txt'
});

Parameters

• oldFileName (required) - Current file path (relative or absolute)
• newFileName (required) - New file path (relative or absolute)

Returns

Promise<boolean> - Returns a promise that resolves with true if the file was renamed/moved successfully, false otherwise

Examples

Simple rename

const success = await web.files.fileRename({
    oldFileName: 'draft.txt',
    newFileName: 'final.txt'
});

if (success) {
    console.log('File renamed successfully');
}

Move to different directory

// Move file from temp to archive
const success = await web.files.fileRename({
    oldFileName: 'temp/report.pdf',
    newFileName: 'archive/2024/report.pdf'
});

Rename with timestamp

const timestamp = new Date().toISOString().replace(/:/g, '-');
const success = await web.files.fileRename({
    oldFileName: 'log.txt',
    newFileName: `logs/log_${timestamp}.txt`
});

Use Cases

• Rename files based on user input
• Move files to different directories
• Organize files into folder structures
• Add timestamps or prefixes to filenames
• Archive old files to different locations

Notes

• Can rename files in the same directory or move to different directories
• Automatically creates destination directories if they don't exist
• Original file is removed after successful rename/move
• Returns false if source file doesn't exist
• Cannot rename if destination file already exists