UNPKG

npmstat

Version:

npm package stats

github.com/bukinoshita/npmstat

bukinoshita/npmstat

133 lines (86 loc) • 2.77 kB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
# npmstat [![Build Status](https://travis-ci.org/bukinoshita/npmstat.svg?branch=master)](https://travis-ci.org/bukinoshita/npmstat) > npm package stats ## Install ``` $ npm install --save npmstat ``` ## Usage ```js const npmstat = require('npmstat') npmstat.getPackage('npmstat').then(res => res) // => { name: 'npmstat', description: 'npm package stats', ... } npmstat.getPackages('bukinoshita').then(res => res) // => [{ name: 'react-cookies', version: '0.1.0', ... }, { name: 'is-github-repo', version: '0.2.0', ... }, ...] npmstat.getDownloads('react-cookies').then(res => res) // => { downloads: 19271, package: 'react-cookies', ... } ``` ## API ### npmstat ### .getPackage(packageName) Returns a `promise`<br/> Get npm package information #### packageName Type: `string`<br/> Required Package name ```js npmstat.getPackage('npmstat') .then(pkg => pkg) .catch(err => err) // => { name: 'npmstat', description: 'npm packages stats', ... } ``` ### .getPackages(username) Returns a `promise`<br/> Get user npm pkgs information #### username Type: `string`<br/> Required npm username ```js npmstat.getPackages('bukinoshita') .then(pkg => pkg) .catch(err => err) // => [{ name: 'react-cookies', version: '0.1.0', ... }, { name: 'is-github-repo', version: '0.2.0', ... }, ...] ``` ### .getDownloads(packageName, [options]) Returns a `promise`<br/> Get npm package downloads count #### packageName Type: `string`<br/> Required Package name ```js npmstat.getDownloads('react-cookies') .then(pkg => pkg) .catch(err => err) // => { downloads: 19271, package: 'react-cookies', ... } ``` #### options Type: `object`<br/> ##### range Type: `string`<br/> Default: `last-month`<br/> Options: `last-day`, `last-week`, `last-month`, `YYYY-MM-DD` (specific date) or `YYYY-MM-DD:YYYY-MM-DD` (specific month) - **last-day**: Gets downloads for the last available day. In practice, this will usually be "yesterday" (in GMT) but if stats for that day have not yet landed, it will be the day before. - **last-week**: Gets downloads for the last 7 available days. - **last-month**: Gets downloads for the last 30 available days. ```js npmstat.getDownloads('react-cookies', { range: 'last-week' }) .then(pkg => pkg) .catch(err => err) // => { downloads: 19271, package: 'react-cookies', ... } ``` ##### type Type: `string`<br/> Default: `point`<br/> Options: `point` or `range` ```js npmstat.getDownloads('react-cookies', { type: 'range' }) .then(pkg => pkg) .catch(err => err) // => { package: 'react-cookies', downloads: [{ downloads: 100, day: '2017-06-8'}, ...], ... } ``` ## Related - [npmstat-cli](https://github.com/bukinoshita/npmstat-cli) — CLI for this module ## License MIT © [Bu Kinoshita](https://bukinoshita.io)