npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

dl-vampire

v2.1.1

Published

download file like a vampire

Downloads

192

Readme

dl-vampire

download file like a vampire

Build Status Coverage Status npm version npm downloads npm license

vampire

Highlight

  • [x] skip mechanism, local file & content-length
  • [x] retry / timeout support
  • [x] stream to file, not ate memory like the download module
  • [x] download progress support, via awesome got module

Install

$ npm i dl-vampire --save

API

import dl, { Vampire, readUrl } from 'dl-vampire'

dl(options: DlOptions) => Promise<{skip: boolean}>

| name | type | required | default value | description | | ----------------------------- | -------------------- | -------- | ---------------------------- | --------------------------------------------------------------------------------------------------------------------- | | options.url | String | true | | the download url | | options.file | String | true | | the local target file path | | options.onprogress | function(progress) | | | got downloadProgress event listener | | options.retry | Object | | {times: 5, timeout: false} | retry options, will pass to promise.retry | | options.skipExists | boolean | | true | if local file already exists AND file stat size match response content-length size, the download will be skiped | | options.expectSize | number | | | validate local file stat.size === expectSize, if check pass the download will be skiped | | options.expectHash | string | | | validate local file file.hash === expectHash, using expectHashAlgorithm if check pass the download will be skiped | | options.expectHashAlgorithm | string | | 'md5' | the expect hash algorithm, default md5 | | options.useChromeUa | Boolean | | true | use user-agent of the Chrome Browser | | options.useProxyEnv | Boolean | | true | use proxy-agent module, will use http_proxy / https_proxy / all_proxy env variable | | options.requestOptions | Object | | | custom request options, see request options |

  • if finally the download is skiped, the return promise will resolve to {skip: true}
  • else it will resolve to {skip: false}

options.retry.*

| name | type | description | | ----------------------- | ---------------------- | ----------------------------------------------------------------------------------------------------------- | | options.retry.times | Number | max retry times | | options.retry.timeout | Number / false | false disables timeout check, Number: max wait in ms | | options.retry.onerror | function(err, index) | when retry happens, this hook will be called, whether a normal error or a timeout error, index is 0 based |

more see https://github.com/magicdawn/promise.retry

ts types

// options for dl() / readUrl()
import type { DlOptions, ReadUrlOptions, ReadUrlOptionsWithEncoding } from 'dl-vampire'

// onpregress type, and progress arg type
import type { OnProgress, Progress } from 'dl-vampire'

Changelog

CHANGELOG.md

License

the MIT License http://magicdawn.mit-license.org