https://github.com/shuvra-matrix/all-url-file-size

all-url-file-size is a Node.js module that allows you to retrieve the file size of a resource hosted at a given URL without downloading
https://github.com/shuvra-matrix/all-url-file-size

all-url-file-size allurlfilesize filesize modules node nodemodule nodemodules npm-module npm-package url urlfilesize

Last synced: 4 days ago
JSON representation

all-url-file-size is a Node.js module that allows you to retrieve the file size of a resource hosted at a given URL without downloading

• Host: GitHub
• URL: https://github.com/shuvra-matrix/all-url-file-size
• Owner: shuvra-matrix
• License: mit
• Created: 2023-09-07T23:55:54.000Z (about 1 year ago)
• Default Branch: main
• Last Pushed: 2024-02-08T05:28:30.000Z (8 months ago)
• Last Synced: 2024-09-26T00:36:51.869Z (8 days ago)
• Topics: all-url-file-size, allurlfilesize, filesize, modules, node, nodemodule, nodemodules, npm-module, npm-package, url, urlfilesize
• Language: JavaScript
• Homepage:
• Size: 6.84 KB
• Stars: 2
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: Readme.md
  • License: LICENSE.md

Awesome Lists containing this project

README

        
# all-url-file-size

**all-url-file-size** is a Node.js module that allows you to retrieve the file size of a resource hosted at a given URL without downloading it while specifying the format (mb, kb, or bytes). This can be useful for various purposes, such as checking the size of remote files before deciding whether to download them.

## Installation

You can install this module using npm or yarn:

```bash

npm install all-url-file-size

```

### Usage

To use all-url-file-size, require it in your Node.js application:

```javascript

const aufs = require("all-url-file-size");

```

### Getting the File Size

You can use the aufs function to retrieve the file size from a URL:

```javascript

const url = "https://example.com/sample-file.zip";

aufs(url)

  .then((size) => {

    console.log(`File size at ${url}: ${size} bytes`);

  })

  .catch((error) => {

    console.error(`Error: ${error.message}`);

  });

```

### Specifying the Format

You can specify the format for the file size by providing the format parameter as either 'bytes', 'kb', or 'mb' . default value is bytes.

```javascript

const url = "https://example.com/sample-file.zip";

const format = "mb";

aufs(url, format)

  .then((size) => {

    console.log(`File size at ${url}: ${size} MB`);

  })

  .catch((error) => {

    console.error(`Error: ${error.message}`);

  });

```

### Timeout and Max Attempt

You can also set a timeout and maximum attempts for the file size retrieval. The default timeout is 20 seconds, and the default max attempt is 4.

```javascript

const url = "https://example.com/sample-file.zip";

const format = "mb";

const timeout = 30000; // 30 seconds

const maxAttempt = 5;

aufs(url, format, timeout, maxAttempt)

  .then((size) => {

    console.log(`File size at ${url}: ${size} MB`);

  })

  .catch((error) => {

    console.error(`Error: ${error.message}`);

  });

```

### License

This project is licensed under the MIT License - see the [LICENSE.md](https://github.com/shuvra-matrix/all-url-file-size/blob/main/LICENSE.md) file for details.