Home

Tutorial

write-npmstat makes it easy to collect, filter and save npm statistics to csv files.

Initilaize a new WriteNpmStat class

In these examples we initilaize a WriteNpmStat class in order to collect statistics about npm-stat-api npm package.

Example - Initilaize without outDir

Because outDir is null the gathered statistics will be only printed to the console.

const WriteNpmStat = require("write-npmstat").default;

const targetPackage = "npm-stat-api";
const writenpmstat = new WriteNpmStat(targetPackage);

Example - Initilaize with outDir

Because outDir is not null the gathered statistics will be saved into csv files too.

const WriteNpmStat = require("write-npmstat").default;

const targetPackage = "npm-stat-api";
const csvDir = "stats/npm-stat-api";
const writenpmstat = new WriteNpmStat(targetPackage, csvDir);

Properties of the WriteNpmStat class

Example - Change outDir

outDir can be changed or set at anytime.

const WriteNpmStat = require("write-npmstat").default;

const targetPackage = "npm-stat-api";
const writenpmstat = new WriteNpmStat(targetPackage);

writenpmstat.outDir = "stats/npm-stat-api";

Example - Change datePeriod

const WriteNpmStat = require("write-npmstat").default;

const targetPackage = "npm-stat-api";
const writenpmstat = new WriteNpmStat(targetPackage);

writenpmstat.datePeriod = "month";

Example - Change mergeStoredData

const WriteNpmStat = require("write-npmstat").default;

const targetPackage = "npm-stat-api";
const writenpmstat = new WriteNpmStat(targetPackage);

writenpmstat.mergeStoredData = false;