Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More
Socket
Sign inDemoInstall
Socket

file_size_url

Package Overview
Dependencies
Maintainers
0
Versions
7
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

file_size_url

A lightweight Node.js library to fetch the file size from a remote URL without downloading the file. Zero dependencies. Returns a Promise with the file size formatted as 'B', 'KB', 'MB', 'GB', or 'TB'.

  • 1.0.6
  • latest
  • Source
  • npm
  • Socket score

Version published
Weekly downloads
31K
decreased by-14.93%
Maintainers
0
Weekly downloads
 
Created
Source

file_size_url

NPM version

NPM monthly downloads

NPM total downloads

file_size_url is a simple Node.js library for fetching the size of a file from a given URL using either HTTP or HTTPS protocols. It returns the file size in a human-readable format such as "1.23 MB".

0 dependencies.

Installation

You can install the library via npm:

npm install file_size_url

Alternatively, if you have the source code, you can directly use the function in your Node.js project:

# Simply copy the source code file to your project directory

Usage

Importing and Using the Library

import fileSizeUrl from 'file_size_url';

fileSizeUrl("https://example.com/file.zip")
  .then(size => console.log(`File size: ${size}`))
  .catch(error => console.error(`Error: ${error.message}`));

Example with telegraf (Telegram Bot)

You can integrate file_size_url with telegraf to fetch and display file sizes in your Telegram bot:

import { Telegraf } from 'telegraf';
import fileSizeUrl from 'file_size_url';

const bot = new Telegraf('<YOUR_BOT_TOKEN>');

bot.command('filesize', async (ctx) => {
  const url = ctx.message.text.split(' ')[1];
  if (!url) return ctx.reply('Please provide a URL.');

  try {
    const size = await fileSizeUrl(url);
    ctx.reply(`File size: ${size}`);
  } catch (error) {
    ctx.reply(`Error: ${error.message}`);
  }
});

bot.launch();

Example with express.js

You can use file_size_url in an express.js server to get file sizes via an API:

import express from 'express';
import fileSizeUrl from 'file_size_url';

const app = express();

app.get('/filesize', (req, res) => {
  const { url } = req.query;
  if (!url) return res.status(400).send('URL parameter is required');

  fileSizeUrl(url)
    .then(size => res.send(`File size: ${size}`))
    .catch(error => res.status(500).send(`Error: ${error.message}`));
});

app.listen(3000, () => {
  console.log('Server is running on port 3000');
});

Using file_size_url in a Loop

You can easily use file_size_url inside a loop to fetch file sizes from multiple URLs:

import fileSizeUrl from './file_size_url.js';

const urls = [
  'https://example.com/file1.zip',
  'https://example.com/file2.zip',
  'https://example.com/file3.zip'
];

urls.forEach(async (url) => {
  try {
    const size = await fileSizeUrl(url);
    console.log(`File size for ${url}: ${size}`);
  } catch (error) {
    console.error(`Error fetching size for ${url}: ${error.message}`);
  }
});

Using file_size_url with Promise.all

Fetch file sizes concurrently for multiple URLs using Promise.all:

import fileSizeUrl from './file_size_url.js';

const urls = [
  'https://example.com/file1.zip',
  'https://example.com/file2.zip',
  'https://example.com/file3.zip'
];

Promise.all(urls.map(url => fileSizeUrl(url)))
  .then(sizes => {
    sizes.forEach((size, index) => {
      console.log(`File size for ${urls[index]}: ${size}`);
    });
  })
  .catch(error => console.error(`Error: ${error.message}`));

API Reference

fileSizeUrl(url)

Fetches the file size from a given URL.

Parameters
  • url (string): The URL of the file.
Returns
  • Promise: Resolves with the file size as a formatted string (e.g., "1.23 MB"). If an error occurs, the promise is rejected with an error message.
Example
fileSizeUrl("https://example.com/file.zip")
  .then(size => console.log(`File size: ${size}`))
  .catch(error => console.error(`Error: ${error.message}`));

Error Handling

  • Invalid URL: If the URL is invalid or missing.
  • The address should be http or https: If the protocol is not supported.
  • Failed to get file size, status code: <statusCode>: If the HTTP status code is not 200.
  • Couldn't retrieve file size from headers: If the content-length header is missing or invalid.

formatBytes(bytes)

Formats bytes into a human-readable string.

Parameters
  • bytes (number): The number of bytes.
Returns
  • string: The formatted size string (e.g., "1.23 MB").
Example
console.log(formatBytes(12345678)); // Output: "11.77 MB"

Notes

  • Make sure the URL starts with http:// or https://.
  • The library is designed to work only in Node.js environments that support the native http and https modules.

License

This library is available under the MIT License.


Arabic Documentation

Keywords

FAQs

Package last updated on 11 Aug 2024

Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap
  • Changelog

Packages

npm

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc