Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/jbuget/url-examiner

A small, easy-to-use, fast and reliable Node.js tool & lib to verify a list of images URL from a CSV input file.
https://github.com/jbuget/url-examiner

Last synced: about 2 months ago
JSON representation

A small, easy-to-use, fast and reliable Node.js tool & lib to verify a list of images URL from a CSV input file.

Awesome Lists containing this project

README

        

# url-examiner

A small Node.js tool & library that checks URL from a given CSV input file and report the analysis results in a new CSV output file.

## Usage

### Prerequisites

You need a working version of:
* Node v14+ (recommended v14.18.0)
* npm 6+ (recommended v6.14.15)

### As a tool

```bash
# Basic
npx url-examiner -i input_file.csv -o output_file.csv

# Advanced (fullname)
npx url-examiner \
--input input_file.csv \
--output output_file.csv \
--timeout 5000 \
--headers "Authorization: Bearer xxx.yyy.zzz"
--headers "User-Agent: Mozilla/5.0 (Windows NT 6.3; Win64; x64; rv:64.0) Gecko/20100101 Firefox/80.0"
--from 10
--to 200
--bulk 50

# Advanced (shortcut)
npx url-examiner \
-i input_file.csv \
-o output_file.csv \
-m 5000 \
-H "Authorization: Bearer xxx.yyy.zzz"
-H "User-Agent: Mozilla/5.0 (Windows NT 6.3; Win64; x64; rv:64.0) Gecko/20100101 Firefox/80.0"
-f 10
-t 200
-b 50
```

**Options:**

| option | description | default value |
| ------ | ----------- | ------------- |
| -d --delay _number_ | delay (in ms) between two URL calls | None |
| -b --bulk _number_ | number of concurrent HTTP calls during analysis phase | 10 |
| -f --from _number_ | line "from" | None |
| -H --headers _headers..._ | HTTP request headers | None |
| (required) -i --input _input_file_ | input file path | None |
| -m --timeout _max-time_ | max time allowed to succeed an HTTP check request | 1000 |
| -o --ouput _filepath_ | ouput file path | None |
| -s --separator _character_ | column separator | ; |
| -t --to _number_ | line "to" | None |

**Input file:**

Supported file extension: `.csv`

Supported data format (without head line):
```
;
```

**Output file:**

![Screenshot](docs/url-examiner_screenshot.png)

### As a library

```bash
npm install url-examiner
```

```javascript
import Program from './Program';

const program = new Program();

program.run('my-app -i input_file.csv -o output_file.csv').then(() => process.exit(0));
```