download-stats

Get and calculate npm download stats for npm modules.

Table of Contents

• Install
• Usage
• API
• Get downloads
• Calculate
• About
  • Related projects
  • Contributing
  • Contributors
  • Release history
  • Building docs
  • Running tests
  • Author
  • License

(TOC generated by verb using markdown-toc)

Install

Install with npm:

1$ npm install --save download-stats

Usage

1var stats = require('download-stats');

API

.get

Get a range of download counts for the specified repository. This method returns a stream of raw data in the form of { day: '2016-01-10', downloads: 123456 }.

Example

1var start = new Date('2016-01-09');
2var end = new Date('2016-01-10');
3stats.get(start, end, 'micromatch')
4  .on('error', console.error)
5  .on('data', function(data) {
6    console.log(data);
7  })
8  .on('end', function() {
9    console.log('done.');
10  });
11// { day: '2016-01-09', downloads: 53331 }
12// { day: '2016-01-10', downloads: 47341 }

Params

• start {Date}: Start date of stream.
• end {Date}: End date of stream.
• repo {String}: Repository to get downloads for. If repo is not passed, then all npm downloads for the day will be returned.
• returns {Stream}: Stream of download data.

.calc

Calculate object containing methods to calculate stats on arrays of download counts. See [calculate][#calculate] api docs for more information.

Get downloads

get

Get a range of download counts for the specified repository. This method returns a stream of raw data in the form of { day: '2016-01-10', downloads: 123456 }.

Example

1var start = new Date('2016-01-09');
2var end = new Date('2016-01-10');
3stats.get(start, end, 'micromatch')
4  .on('error', console.error)
5  .on('data', function(data) {
6    console.log(data);
7  })
8  .on('end', function() {
9    console.log('done.');
10  });
11// { day: '2016-01-09', downloads: 53331 }
12// { day: '2016-01-10', downloads: 47341 }

Params

• start {Date}: Start date of stream.
• end {Date}: End date of stream.
• repo {String}: Repository to get downloads for. If repo is not passed, then all npm downloads for the day will be returned.
• returns {Stream}: Stream of download data.

.point

Get a specific point (all-time, last-month, last-week, last-day)

Example

1stats.get.period('last-day', 'micromatch', function(err, results) {
2  if (err) return console.error(err);
3  console.log(results);
4});
5// { day: '2016-01-10', downloads: 47341 }

Params

• period {String}: Period to retrieve downloads for.
• repo {String}: Repository to retrieve downloads for.
• cb {Function}: Callback function to get results

.allTime

Get the all time total downloads for a repository.

Example

1stats.get.allTime('micromatch', function(err, results) {
2  if (err) return console.error(err);
3  console.log(results);
4});
5// { day: '2016-01-10', downloads: 47341 }

Params

• repo {String}: Repository to retrieve downloads for.
• cb {Function}: Callback function to get results

.lastMonth

Get the last month's total downloads for a repository.

Example

1stats.get.lastMonth('micromatch', function(err, results) {
2  if (err) return console.error(err);
3  console.log(results);
4});
5// { downloads: 7750788, start: '2016-10-10', end: '2016-11-08', package: 'micromatch' }

Params

• repo {String}: Repository to retrieve downloads for.
• cb {Function}: Callback function to get results

.lastWeek

Get the last week's total downloads for a repository.

Example

1stats.get.lastWeek('micromatch', function(err, results) {
2  if (err) return console.error(err);
3  console.log(results);
4});
5// { downloads: 1777065, start: '2016-11-02', end: '2016-11-08', package: 'micromatch' }

Params

• repo {String}: Repository to retrieve downloads for.
• cb {Function}: Callback function to get results

.lastDay

Get the last day's total downloads for a repository.

Example

1stats.get.lastDay('micromatch', function(err, results) {
2  if (err) return console.error(err);
3  console.log(results);
4});
5// { downloads: 316004, start: '2016-11-08', end: '2016-11-08', package: 'micromatch' }

Params

• repo {String}: Repository to retrieve downloads for.
• cb {Function}: Callback function to get results

Calculate

.group

Group array into object where keys are groups and values are arrays. Groups determined by provided fn.

Example

1var groups = calculate.group(downloads, function(download) {
2  // day is formatted as '2010-12-25'
3  // add this download to the '2010-12' group
4  return download.day.substr(0, 7);
5});

Params

• arr {Array}: Array of download objects
• fn {Function}: Function to determine group the download belongs in.
• returns {String}: Key to use for the group

.group.total

Calculate the total for each group (key) in the object.

Params

• groups {Object}: Object created by a group function.
• returns {Object}: Object with calculated totals

.total

Calculate the total downloads for an array of download objects.

Params

• arr {Array}: Array of download objects (must have a .downloads property)
• returns {Number}: Total of all downloads in the array.

.group.avg

Calculate the average for each group (key) in the object.

Params

• groups {Object}: Object created by a group function.
• returns {Object}: Object with calculated average

.avg

Calculate the average downloads for an array of download objects.

Params

• arr {Array}: Array of download objects (must have a .downloads property)
• returns {Number}: Average of all downloads in the array.

.group.before

Create an array of downloads before specified day.

Params

• day {String}: Day specifying last day to use in group.
• arr {Array}: Array of downloads to check.
• returns {Array}: Array of downloads happened before or on specified day.

.before

Calculate the total downloads happening before the specified day.

Params

• day {String}: Day specifying last day to use in group.
• arr {Array}: Array of downloads to check.
• returns {Number}: Total downloads happening before or on specified day.

.group.last

Create an array of downloads for the last X days.

Params

• days {Number}: Number of days to go back.
• arr {Array}: Array of downloads to check.
• init {String}: Optional day to use as the last day to include. (Days from init || today - days to init || today)
• returns {Array}: Array of downloads for last X days.

.last

Calculate total downloads for the last X days.

Params

• days {Number}: Number of days to go back.
• arr {Array}: Array of downloads to check.
• init {String}: Optional day to use as the last day to include. (Days from init || today - days to init || today)
• returns {Array}: Array of downloads for last X days.

.group.prev

Create an array of downloads for the previous X days.

Params

• days {Number}: Number of days to go back.
• arr {Array}: Array of downloads to check.
• init {String}: Optional day to use as the prev day to include. (Days from init || today - days - days to init || today - days)
• returns {Array}: Array of downloads for prev X days.

.prev

Calculate total downloads for the previous X days.

Params

• days {Number}: Number of days to go back.
• arr {Array}: Array of downloads to check.
• init {String}: Optional day to use as the prev day to include. (Days from init || today - days - days to init || today - days)
• returns {Array}: Array of downloads for prev X days.

.monthly

Create an object of download groups by month.

Params

• arr {Array}: Array of downloads to group and total.
• returns {Object}: Groups with arrays of download objects

.monthly

Calculate total downloads grouped by month.

Params

• arr {Array}: Array of downloads to group and total.
• returns {Object}: Groups with total downloads calculated

.yearly

Create an object of download groups by month.

Params

• arr {Array}: Array of downloads to group and total.
• returns {Object}: Groups with arrays of download objects

.yearly

Calculate total downloads grouped by year.

Params

• arr {Array}: Array of downloads to group and total.
• returns {Object}: Groups with total downloads calculated

About

Contributing

Pull requests and stars are always welcome. For bugs and feature requests, please create an issue.

Building docs

(This document was generated by verb-generate-readme (a verb generator), please don't edit the readme directly. Any changes to the readme must be made in .verb.md.)

To generate the readme and API documentation with verb:

1$ npm install -g verb verb-generate-readme && verb

Running tests

Install dev dependencies:

1$ npm install -d && npm test

Author

Brian Woodward

• github/doowb
• twitter/doowb

License

Copyright © 2016, Brian Woodward. Released under the MIT license.

---

This file was generated by verb-generate-readme, v0.2.0, on November 09, 2016.