https://github.com/nswbmw/npm-package-downloads
Get packages download counts.
https://github.com/nswbmw/npm-package-downloads
Last synced: 4 months ago
JSON representation
Get packages download counts.
- Host: GitHub
- URL: https://github.com/nswbmw/npm-package-downloads
- Owner: nswbmw
- Created: 2016-01-14T06:13:38.000Z (almost 10 years ago)
- Default Branch: master
- Last Pushed: 2018-08-10T01:57:03.000Z (about 7 years ago)
- Last Synced: 2025-06-02T17:57:38.459Z (5 months ago)
- Language: JavaScript
- Size: 3.91 KB
- Stars: 5
- Watchers: 2
- Forks: 3
- Open Issues: 1
-
Metadata Files:
- Readme: readme.md
Awesome Lists containing this project
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