README
Author Downloads
Get an author's package download counts.
Installation
$ npm install npm-author-download-counts
Usage
var counts = require( 'npm-author-download-counts' );
counts( options, clbk )
Get an author's package download counts.
var opts = {
'username': 'kgryte'
};
counts( opts, clbk );
function clbk( error, data ) {
if ( error ) {
throw error;
}
console.dir( data );
/*
[
{
"package": "app-boot",
"data": [
["2015-12-01T00:00:00.000Z",3295],
["2015-12-02T00:00:00.000Z",5498],
["2015-12-03T00:00:00.000Z",4771],
...
]
},
{
"package": "app-etc",
"data": [
["2015-12-01T00:00:00.000Z",1003],
["2015-12-02T00:00:00.000Z",809],
["2015-12-03T00:00:00.000Z",946],
...
]
},
...
]
*/
}
The function
accepts the following options
:
- username: author username (required).
- period: query period. May be either a keyword (e.g.,
'last-month'
,'last-week'
,'last-day'
) or a date range (e.g.,'2015-12-01:2016-01-01'
). Default:'last-month'
.
By default, the function
returns daily downloads for the last month. To return daily downloads for an alternative period, set the period
option.
var opts = {
'username': 'kgryte',
'period': '2015-11-01:2015-12-31'
};
counts( opts, clbk );
counts.factory( options, clbk )
Creates a reusable function
.
var get = counts.factory( {'username':'kgryte'}, clbk );
get();
get();
get();
// ...
The factory method accepts the same options
as counts()
.
Notes
- If the module encounters an application-level
error
(e.g., no network connection, malformed request, etc), thaterror
is returned immediately to the providedcallback
. - Time values are in simplified ISO format (ISO 8601).
- A query
period
is not sanity checked. If counts are expected, ensure that the providedperiod
is of the appropriate format and/or a recognized value.
Examples
var counts = require( 'npm-author-download-counts' );
var opts = {
'username': 'kgryte'
};
counts( opts, onCounts );
function onCounts( error, data ) {
if ( error ) {
throw error;
}
console.dir( data );
}
To run the example code from the top-level application directory,
$ DEBUG=* node ./examples/index.js
CLI
Installation
To use the module as a general utility, install the module globally
$ npm install -g npm-author-download-counts
Usage
Usage: apkgcounts [options] username
Options:
-h, --help Print this message.
-V, --version Print the package version.
--period period Query period. May be either a keyword (e.g.,
'last-month','last-week','last-day') or a date
range (e.g., '2015-12-01:2016-01-01'). Default:
'last-month'.
--format format Output format: csv or json. Default: 'csv'.
--delimiter delimiter CSV column delimiter. Default: ','.
Notes
- If the output format is
csv
and the process is unable to resolve counts, the process will write anerror
message tostderr
and will not generate CSV output.
Examples
$ DEBUG=* apkgcounts kgryte
# => time,app-boot,app-etc
# => 2015-12-01T00:00:00.000Z,3295,1003
# => 2015-12-02T00:00:00.000Z,5498,809
# => 2015-12-03T00:00:00.000Z,4771,946
# => ...
To output as newline-delimited JSON (ndjson), set the format
option.
$ DEBUG=* apkgcounts --format=json kgryte
# => {"app-boot":[[...],[...],...]}
# => {"app-etc":[[...],[...],...]}
Tests
Unit
This repository uses tape for unit tests. To run the tests, execute the following command in the top-level application directory:
$ make test
All new feature development should have corresponding unit tests to validate correct functionality.
Test Coverage
This repository uses Istanbul as its code coverage tool. To generate a test coverage report, execute the following command in the top-level application directory:
$ make test-cov
Istanbul creates a ./reports/coverage
directory. To access an HTML version of the report,
$ make view-cov
Browser Support
This repository uses Testling for browser testing. To run the tests in a (headless) local web browser, execute the following command in the top-level application directory:
$ make test-browsers
To view the tests in a local web browser,
$ make view-browser-tests
License
Copyright
Copyright © 2016. Athan Reines.