clone-stats

What is clone-stats?

The clone-stats npm package is designed to clone the stats from one fs.Stats instance to another. This is particularly useful when you're working with file system operations in Node.js and need to replicate file or directory statistics accurately without modifying the original stats object. It provides a straightforward and efficient way to copy stats, ensuring that all the properties are cloned correctly.

What are clone-stats's main functionalities?

Cloning fs.Stats instance

This code demonstrates how to clone the statistics of a file system object using clone-stats. It first requires the clone-stats and fs modules. Then, it uses fs.stat to get the stats of a specific file and clone-stats to clone these stats into a new variable, allowing for manipulation or comparison without affecting the original stats object.

const cloneStats = require('clone-stats');
const fs = require('fs');

fs.stat('/path/to/file', (err, stats) => {
  if (err) throw err;
  const clonedStats = cloneStats(stats);
  console.log(clonedStats);
});

Other packages similar to clone-stats

clone

The clone package offers a more general cloning functionality that can be used not only for fs.Stats objects but for cloning any JavaScript objects. It provides deep cloning capabilities, which means it can clone nested objects as well. Compared to clone-stats, clone is more versatile but might be overkill for specific use cases where only fs.Stats objects need to be cloned.

clone-deep

Similar to the clone package, clone-deep offers deep cloning functionality for JavaScript objects. It ensures that even deeply nested properties are cloned. While clone-deep is powerful for a wide range of objects, clone-stats is specifically optimized for fs.Stats objects, potentially making it more efficient for that particular use case.

README

clone-stats

Safely clone node's fs.Stats instances without losing their class methods, i.e. stat.isDirectory() and co.

Usage

copy = require('clone-stats')(stat)

Returns a clone of the original fs.Stats instance (stat).

License

MIT. See LICENSE.md for details.