# npm-package-downloads

> Get packages download counts.

Latest version **1.2.0** (published 2018-08-10) · MIT license · 0 weekly downloads

## Install

```sh
npm install npm-package-downloads
pnpm add npm-package-downloads
yarn add npm-package-downloads
bun add npm-package-downloads
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.2.0 |
| Published | 2018-08-10 |
| First published | 2016-01-14 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >= 0.12 |
| Dependencies | 4 |
| Unpacked size | 4.7 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 5 |
| Maintainers | nswbmw |
| Keywords | package, pkg, download, count |

## Links

- npm: https://www.npmjs.com/package/npm-package-downloads
- Repository: https://github.com/nswbmw/npm-package-downloads
- Homepage: https://github.com/nswbmw/npm-package-downloads#readme
- Issues: https://github.com/nswbmw/npm-package-downloads/issues
- npm.io page: https://npm.io/package/npm-package-downloads

## Dependencies (4)

- [lodash](https://npm.io/package/lodash.md) ^4.17.10
- [bluebird](https://npm.io/package/bluebird.md) ^3.5.1
- [superagent](https://npm.io/package/superagent.md) ^3.8.3
- [superagent-bluebird-promise](https://npm.io/package/superagent-bluebird-promise.md) ^4.2.0

## Recent versions

- 1.2.0 (latest) — 2018-08-10
- 1.1.0 — 2017-07-12
- 1.0.1 — 2016-01-17
- 1.0.0 — 2016-01-14

## README

## npm-package-downloads

fetch packages download counts.

### Install

```bash
$ npm i npm-package-downloads --save
```

### Usage

```
npmPackageDownloads(pkgName(s), period)
```

- pkgName`{String|Array(String)}`: pkg name or array of pkgs name. eg: 'express', ['express', 'koa']
- period`{String}`:
  - semantic: 'last-day', 'last-week', 'last-month'
  - specific date: '2016-01-01'
  - specific range: '2016-01-01:2016-01-31'

### Example

```javascript
'use strict';

var npmPackageDownloads = require('npm-package-downloads');

npmPackageDownloads('').catch(function (error) {
  console.log(error.message);
  // npm-package-downloads need a module name or array of names.
});

npmPackageDownloads('express', 'last-month').then(function (res) {
  console.log(res);
  // { downloads: 13359424,
  //   package: 'express',
  //   start: '2017-06-12',
  //   end: '2017-07-11' }
});

npmPackageDownloads([
  'express',// exist
  'ahudsfgikaj',// not exist
  '@shimo/gulp-build',// exist
  '@shimo/gulp-buildhaha'// not exist
], '2016-01-01:2016-01-31').then(function (res) {
  console.log(res);
  // [ { downloads: 0,
  //     start: '2016-01-01',
  //     end: '2016-01-31',
  //     package: '@shimo/gulp-build' },
  //   { package: '@shimo/gulp-buildhaha' },
  //   { downloads: 4686332,
  //     package: 'express',
  //     start: '2016-01-01',
  //     end: '2016-01-31' },
  //   { package: 'ahudsfgikaj' } ]
});
```

### License

MIT

---
_Source: https://npm.io/package/npm-package-downloads · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._