Basic File Operations in Kawkab

The File class in the Kawkab framework provides a powerful way to manage files easily and efficiently. In this guide, we will explore how to use all the available file operations.

Importing

Before using any of the operations, you must import the class:

import { file } from 'kawkab';

Available File Operations

1. Check if a File Exists (exists)

Check if a file exists before performing any operation on it.

const fileExists = await file.exists('storage/public/config.json');
if (fileExists) {
    console.log('File exists');
} else {
    console.log('File does not exist');
}

2. Read File Content (read)

Read the entire content of a text file.

const content = await file.read('storage/public/config.json');
console.log(content); // Displays file content

3. Write Content to a File (write)

Write or replace content in a file.

const data = {
    name: "Kawkab App",
    version: "1.0.0"
};
await file.write('storage/public/config.json', JSON.stringify(data, null, 2));

4. Append Content to a File (append)

Append new content to the end of an existing file.

await file.append('storage/public/log.txt', 'Logged in at ' + new Date().toISOString() + '\n');

5. Delete a File (delete)

Delete a file from the system.

await file.delete('storage/public/temp.txt');

6. List Files (list)

Get a list of files in a folder with detailed information.

const files = await file.list('storage/public');
files.forEach(file => {
    console.log(`File Name: ${file.name}`);
    console.log(`Size: ${file.stats.size} bytes`);
    console.log(`Creation Date: ${file.stats.created}`);
    console.log(`Last Modified: ${file.stats.modified}`);
    console.log(`Type: ${file.stats.isDirectory ? 'Directory' : 'File'}`);
    console.log('---');
});

7. Copy a File (copy)

Copy a file from one location to another.

await file.copy('storage/public/source.txt', 'storage/public/backup/source-backup.txt');

8. Move a File (move)

Move a file from one location to another.

await file.move('storage/public/old-location.txt', 'storage/public/new-location.txt');

9. File Information (stats)

Get detailed information about a file.

const stats = await file.stats('document.pdf');
console.log(`File Size: ${stats.size} bytes`);
console.log(`Creation Date: ${stats.created}`);
console.log(`Last Modified: ${stats.modified}`);
console.log(`Is it a directory? ${stats.isDirectory}`);

Practical Examples

Example 1: Check if a File Exists Before Reading

async function readIfExists(fileName: string) {
    try {
        if (await file.exists(fileName)) {
            const content = await file.read(fileName);
            return content;
        }
        return null;
    } catch (error) {
        console.error('Error occurred:', error.message);
        return null;
    }
}

Example 2: Copy a File with Existence Check

async function safeBackup(fileName: string) {
    const backupName = `${fileName}.backup`;
    
    try {
        if (await file.exists(fileName)) {
            await file.copy(fileName, backupName);
            console.log('Backup created successfully');
            return true;
        }
        console.log('Original file does not exist');
        return false;
    } catch (error) {
        console.error('Failed to create backup:', error.message);
        return false;
    }
}

Best Practices

Check File Existence: Always use exists() before performing any file operations to avoid errors.
Error Handling: Always use try-catch for error handling to manage potential issues.
Relative Paths: Use relative paths instead of absolute paths to improve portability.
Type Checking: Use stats.isDirectory to check the type of the item before performing operations.

Important Notes

All operations are asynchronous (use Promises).
You can use both relative and absolute paths.
All operations safely handle errors.
Use init() to set the base path at the start of the application.

Conclusion

The File class in Kawkab provides a robust and easy-to-use interface for handling files. With the addition of the exists() function and other improvements, managing files becomes safer and more reliable. Use these functions along with the best practices to get the best results in your application.

Time Folders