Node.js — Get the Size of a File

Node.js ships with the native fs module to interact with the local file system. The fs module supports retrieving statistics for a file on your local disk. You may also get the size of a file from these statistics.

This tutorial shows you how to retrieve the file size in bytes for a given file on your local hard drive.

Node.js Series Overview

  1. String Replace All Appearances
  2. Remove All Whitespace From a String in JavaScript
  3. Generate a Random ID or String in Node.js or JavaScript
  4. Remove Extra Spaces From a String in JavaScript or Node.js
  5. Remove Numbers From a String in JavaScript or Node.js
  6. Get the Part Before a Character in a String in JavaScript or Node.js
  7. Get the Part After a Character in a String in JavaScript or Node.js
  8. How to Check if a Value is a String in JavaScript or Node.js
  9. Check If a String Includes All Strings in JavaScript/Node.js/TypeScript
  10. Check if a Value is a String in JavaScript and Node.js
  11. Limit and Truncate a String to a Given Length in JavaScript and Node.js
  12. Split a String into a List of Characters in JavaScript and Node.js
  13. How to Generage a UUID in Node.js
  14. Reverse a String in JavaScript or Node.js
  15. Split a String into a List of Lines in JavaScript or Node.js
  16. Split a String into a List of Words in JavaScript or Node.js
  17. Detect if a String is in camelCase Format in Javascript or Node.js
  18. Check If a String Is in Lowercase in JavaScript or Node.js
  19. Check If a String is in Uppercase in JavaScript or Node.js
  20. Get the Part After First Occurrence in a String in JavaScript or Node.js
  21. Get the Part Before First Occurrence in a String in JavaScript or Node.js
  22. Get the Part Before Last Occurrence in a String in JavaScript or Node.js
  23. Get the Part After Last Occurrence in a String in JavaScript or Node.js
  24. How to Count Words in a File
  25. How to Shuffle the Characters of a String in JavaScript or Node.js
  26. Append Characters or Words to a String in JavaScript or Node.js (Coming soon)
  27. Check if a String is Empty in JavaScript or Node.js (Coming soon)
  28. Ensure a String Ends with a Given Character in JavaScript or Node.js (Coming soon)
  29. Left-Trim Characters Off a String in JavaScript or Node.js (Coming soon)
  30. Right-Trim Characters Off a String in JavaScript or Node.js (Coming soon)
  31. Lowercase the First Character of a String in JavaScript or Node.js (Coming soon)
  32. Uppercase the First Character of a String in JavaScript or Node.js (Coming soon)
  33. Prepend Characters or Words to a String in JavaScript or Node.js (Coming soon)

Retrieve the File Size in Node.js

The way to retrieve the file size in Node.js is to first get a file’s statistics object, also called “stats”. This stats object contains the size attribute describing the size of the file in bytes.

Here’s the sample code for a fileSize utility method returning the size of a file in bytes:

import Fs from 'fs/promises'

/**
 * Returns the file size of the file located at `path` in bytes.
 *
 * @param {String} path
 *
 * @returns {Number}
 */
async function fileSize (path) {  
  const stats = await Fs.stat(path)

  return stat.size
}

Then you may use the fileSize method like this:

const sizeInBytes = await fileSize('./package.json')  
// 149

Use the @supercharge/fs Package

I’m the maintainer of the @supercharge/fs package providing convenient file system utilities. The @supercharge/fs package comes with a handy Fs.size(path) method returning the size of the file located at path in bytes :

import Fs from '@supercharge/fs'

const sizeInBytes = await Fs.size('./package.json')  
// 1493

That’s it!


Mentioned Resources

Explore the Library

Find interesting tutorials and solutions for your problems.