Introduction to Filesize API

Filesize is an essential API for developers working with file management. It allows you to easily obtain and handle file size information in a precise and efficient manner. In this post, we’ll cover various Filesize API methods and provide practical code snippets to help you get started. Additionally, we will introduce an application example utilizing these APIs.

Basic Usage

The basic usage of the Filesize API involves calling the method to get the size of a file. Here’s a simple example:

  const filesize = require('filesize');
  console.log(filesize(265318)); // Output: "265.32 kB"

Units Conversion

Filesize API can convert file sizes into different units such as bytes, kilobytes, megabytes, etc. Here’s an example:

  const filesize = require('filesize');
  console.log(filesize(265318, {round: 0})); // Output: "265 kB"
  console.log(filesize(265318, {exponent: 2})); // Output: "0.25 MB"

Options

The Filesize API comes with several options you can configure:

• bits: Boolean to display output in bits.
• unix: Boolean to enable UNIX style output.
• base: Number to set the numerical base (2 or 10).

Here are examples demonstrating these options:

  const filesize = require('filesize');
  console.log(filesize(265318, {bits: true})); // Output: "2.12 Mbits"
  console.log(filesize(265318, {unix: true})); // Output: "259.1k"
  console.log(filesize(265318, {base: 2})); // Output: "259.13 KiB"

Localization

Another great feature is the localization option. You can localize the file size output to match your preferred locale:

  const filesize = require('filesize');
  console.log(filesize(265318, {locale: 'fr'})); // Output: "265,32 kB"

Application Example

Let’s put all the knowledge together and create a simple Node.js application that reads a file, gets its size, and logs it in various formats:

  const fs = require('fs');
  const filesize = require('filesize');
  
  const filePath = './example.txt'; 
  fs.stat(filePath, (err, stats) => {
    if (err) {
      console.error(err);
    } else {
      let sizeInBytes = stats.size;
      console.log('File Size in Bytes: ' + filesize(sizeInBytes));
      console.log('File Size in KiloBytes: ' + filesize(sizeInBytes, {round: 0}));
      console.log('File Size in MegaBytes: ' + filesize(sizeInBytes, {exponent: 2}));
    }
  });

By understanding and applying the Filesize API effectively, you can manage file sizes more proficiently, ensuring that your applications are optimized for both performance and usability.

Hash: 7cc427ea1473ac41c40717007d5f648681dc80ec0da3ad2eaa4b9a77f36295f6