Introduction to cp-file

The cp-file module is a highly efficient tool for copying files in Node.js applications. It promises better performance, error handling, and additional features over the native fs module. Let’s dive into the plethora of APIs it offers and demonstrate their uses with code snippets.

Basic File Copying

The fundamental use of cp-file is to copy files from one location to another:

  
    const cpFile = require('cp-file');

    (async () => {
        await cpFile('source.txt', 'destination.txt');
        console.log('File copied');
    })();
  

File Overwriting Control

The cp-file module allows you to control whether existing files should be overwritten:

  
    const cpFile = require('cp-file');

    (async () => {
        await cpFile('source.txt', 'destination.txt', { overwrite: false });
        console.log('File copied without overwriting');
    })();
  

Preserving Timestamps

You can preserve the timestamps of the source file:

  
    const cpFile = require('cp-file');

    (async () => {
        await cpFile('source.txt', 'destination.txt', { preserveTimestamps: true });
        console.log('Timestamps preserved');
    })();
  

Directory Copying

Although cp-file is designed for single files, here’s how you can copy directories using cpy, which is built on cp-file:

  
    const cpy = require('cpy');

    (async () => {
        await cpy('source/*', 'destination');
        console.log('Directory copied');
    })();
  

Progress Reporting

The module also supports progress reporting during file copy operations:

  
    const cpFile = require('cp-file');

    cpFile('source.txt', 'destination.txt')
        .on('progress', progress => {
            console.log(progress.percent);
        })
        .then(() => {
            console.log('File copied with progress');
        });
  

Error Handling

cp-file supports robust error handling for better management:

  
    const cpFile = require('cp-file');

    (async () => {
        try {
            await cpFile('source.txt', 'destination.txt');
        } catch (error) {
            console.error('Copy failed:', error);
        }
    })();
  

Example Application Utilizing Multiple APIs

Here is an example application demonstrating the use of multiple cp-file APIs:

  
    const cpFile = require('cp-file');
    const cpy = require('cpy');

    (async () => {
        await cpFile('config.json', 'backup/config.json', { overwrite: false });
        await cpy('assets/*', 'public/assets', { overwrite: true });

        cpFile('logs.txt', 'backup/logs.txt')
            .on('progress', progress => {
                console.log(`Progress: ${progress.percent * 100}%`);
            })
            .then(() => {
                console.log('Logs backed up successfully');
            })
            .catch(error => {
                console.error('Error during logs backup:', error);
            });

        console.log('Application setup completed successfully');
    })();
  

By leveraging the robust features of cp-file, you can manage file operations more efficiently in your Node.js applications.

Hash: c8702421a3cf3bdc16a2f5846aed7097b26764bd5ff70c93203f209a8f6fd20e