Revamp #14

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged

fityannugroho merged 14 commits into main from revamp

Jun 29, 2024

.github/workflows/main.yml

            
                      Original file line number
                      Diff line number
                      Diff line change
                  
    @@ -10,12 +10,13 @@ on:
  
        branches: ['main']

    jobs:

      build:

      build_and_test:

        runs-on: ubuntu-latest

        strategy:

          matrix:

            node-version: [18.x, 20.x]

            node-version:

              - 20.x

            # See supported Node.js release schedule at https://nodejs.org/en/about/releases/

        steps:

    @@ -24,8 +25,7 @@ jobs:
  
            uses: actions/setup-node@v4

            with:

              node-version: ${{ matrix.node-version }}

              cache: 'npm'

          - run: npm ci

          - run: npm run lint

          - run: npm run build --if-present

          - run: npm run build

          - run: npm test

README.md

            
                      Original file line number
                      Diff line number
                      Diff line change
                  
    @@ -1,16 +1,45 @@
  
    # img-dl

    Downloade image(s), by command or programmatically. The alternative for `image-downloader` package (see the [comparison](#comparison)).

    Downloade image(s), by command or programmatically. The alternative for `image-downloader` package (see the [features](#features)).

    [![MIT license](https://img.shields.io/github/license/fityannugroho/img-dl.svg)](https://github.com/fityannugroho/img-dl/blob/main/LICENSE)

    [![npm version](https://img.shields.io/npm/v/img-dl.svg)](https://www.npmjs.com/package/img-dl)

    [![npm downloads](https://img.shields.io/npm/dm/img-dl.svg)](https://www.npmjs.com/package/img-dl)

    [![install size](https://packagephobia.com/badge?p=img-dl)](https://packagephobia.com/result?p=img-dl)

    ## Features

    | Features                    | **img-dl** | [image-downloader][p1] |

    | --------------------------- | :--------: | :--------------------: |

    | Single download             |     ✅     |           ✅           |

    | Bulk download               |     ✅     |           ❌           |

    | CLI                         |     ✅     |           ❌           |

    | Custom filename             |     ✅     |           ✅           |

    | Custom extension            |     ✅     |           ❌           |

    | Request timeout             |     ✅     |           ✅           |

    | Retry failed request        |     ✅     |           ❌           |

    | Abort request               |     ✅     |           ❌           |

    | **Increment mode (in CLI)** |     ✅     |           ❌           |

    | **Overwrite prevention**    |     ✅     |           ❌           |

    ### Increment mode

    Download images with an url that contains `{i}` placeholder for the index, and specify the start and end index.

    ### Overwrite prevention

    To prevent overwriting, ` (n)` will be appended to the name of the new file if the file with the same name already exists.

    The number will be incremented until the file name is unique in the directory, starting from 1 (e.g. `image (1).jpg`, `image (2).jpg`, etc.).

    Image with different extension will be considered as **different** file, so it will not be appended with ` (n)`. For example, `image.jpg` and `image.png` will not be considered as the same file.

    > This feature will work for both single and bulk download.

    ## Prerequisites

    - Node.js 18 or later

    - npm 9 or later

    - Node.js 20.9 or later

    - npm 10 or later

    ## Installation

    @@ -43,7 +72,7 @@ USAGE
  
    PARAMETERS

      url   The URL of the image to download. Provide multiple URLs to download multiple images.

            In increment mode, the URL must contain {i} placeholder for the index,

            only one URL is allowed, and the 'end' flag is required.

            only one URL is allowed, and the '--end' is required.

    OPTIONS

      -d, --dir=<path>          The output directory. Default: current working directory

    @@ -53,7 +82,7 @@ OPTIONS
  
      -H, --header=<header>     The header to send with the request. Can be used multiple times

      -i, --increment           Enable increment mode. Default: false

          --interval=<number>   The interval between each batch of requests in milliseconds

      -n, --name=<filename>     The filename. Default: original filename or timestamp

      -n, --name=<filename>     The filename. If not specified, the original filename will be used. Default: 'image'

          --max-retry=<number>  Set the maximum number of times to retry the request if it fails

          --silent              Disable logging

          --start=<number>      The start index for increment mode. Default: 0

    @@ -76,13 +105,13 @@ EXAMPLES
  
    imgdl https://example.com/image.jpg

    ```

    #### Download multiple images

    #### Bulk download

    ```bash

    imgdl https://example.com/image.jpg https://example.com/image2.jpg

    ```

    #### Download multiple images with increment mode

    #### Bulk download with increment mode

    ```bash

    imgdl https://example.com/image-{i}.jpg --increment --start=1 --end=10

    @@ -95,7 +124,12 @@ imgdl https://example.com/image-{i}.jpg --increment --start=1 --end=10
  
    ```js

    import imgdl from 'img-dl';

    const image = await imgdl('https://example.com/image.jpg');

    const image = await new Promise((resolve, reject) => {

      imgdl('https://example.com/image.jpg', {

        onSuccess: resolve,

        onError: reject,

      });

    });

    console.log(image);

    /*

    {

    @@ -110,21 +144,36 @@ console.log(image);
  
    */

    ```

    #### Download multiple images

    #### Bulk download

    ```js

    import imgdl from 'img-dl';

    const images = await imgdl([

    const urls = [

      'https://example.com/image.jpg',

      'https://example.com/image2.jpg',

    ]);

    ];

    await imgdl(urls, {

      onSuccess: (image) => {

        // Do something with the downloaded image

        console.log(image);

      },

      onError: (error, url) => {

        // Do something when the image fails to download

        console.error(`Failed to download ${url}: ${error.message}`);

      },

    });

    console.log('Download completed');

    ```

    ## API

    ### imgdl(url, ?options)

    Returns: `Promise<void>`

    Download image(s) from the given URL(s).

    #### `url`

    @@ -172,7 +221,7 @@ The interval between each batch of requests in milliseconds when downloading mul
  
    Type: `string`<br>

    Default: `'image'`

    The filename. If not specified, the original filename will be used. If the original filename is not available, 'image' will be used. <br>When downloading multiple images, `-index` will be appended to the end of the name (suffix). `index` will start from 1. For example: 'image-1'

    The filename. If not specified, the original filename will be used. If the original filename is not available, 'image' will be used.

    ##### `maxRetry`

    @@ -186,14 +235,14 @@ Set the maximum number of times to retry the request if it fails.
  
    Type: `(image: Image) => void`<br>

    Default: `undefined`

    The callback function to be called when the image is successfully downloaded. Only available when downloading multiple images.

    The callback function to be called when the image is successfully downloaded.

    ##### `onError`

    Type: `(error: Error, url: string) => void`<br>

    Default: `undefined`

    The callback function to be called when the image fails to download. Only available when downloading multiple images.

    The callback function to be called when the image fails to download.

    ##### `signal`

    @@ -216,20 +265,6 @@ Default: `undefined`
  
    Set timeout for each request in milliseconds.

    ## Comparison

    | Features                 | **img-dl** | [image-downloader][p1] |

    | ------------------------ | :--------: | :--------------------: |

    | Download single image    |     ✅     |           ✅           |

    | Download multiple images |     ✅     |           ❌           |

    | CLI                      |     ✅     |           ❌           |

    | Increment download       |     ✅     |           ❌           |

    | Custom filename          |     ✅     |           ✅           |

    | Custom extension         |     ✅     |           ❌           |

    | Request timeout          |     ✅     |           ✅           |

    | Retry failed request     |     ✅     |           ❌           |

    | Abort request            |     ✅     |           ❌           |

    <!-- Project links -->

    [p1]: https://www.npmjs.com/package/image-downloader

    @@ -238,4 +273,4 @@ Set timeout for each request in milliseconds.
  
    Give a ⭐️ if this project helped you!

    You can support this project by donating via [GitHub Sponsors](https://github.com/sponsors/fityannugroho), [Trakteer](https://trakteer.id/fityannugroho/tip), or [Saweria](https://saweria.co/fityannugroho).

    Also please consider supporting this project with a **donation**. Your donation will help us maintain and develop this project and provide you with better support.

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Revamp #14

Uh oh!

Diff view

Diff view

There are no files selected for viewing

Uh oh!