History-store NPM

history-store

historys-store is a server-side module used to store different versions of report. When used with history-trend, it becomes possible to compute any trend of any report over time.

This is a very simple persistent file system storage which is not intended to support huge volume.

Installation

To use with node:

$ npm install history-store

Usage

var // creates stores root on ../history folder
    stores = require('history-store')('../history'),
    // creates a store dedicated to IssueReport
    issueReportStore = stores.report('IssueReport'),
    // here is a typical report to store and access
    report = { date: new Date('1995-12-17T03:24:00'), issues: [{ key: 'JIRA-123', status: 'New'}, { key: 'JIRA-456', status: 'In Progress'}]};

// stores report
issueReportStore.put(report, function (err) {});

// gets all reports
issueReportStore.get(function (err, reports) {});

// it is also possible (and recommended) to stream reports individually
var stream = issueReportStore.stream();

stream.on('data', function (report) {});
stream.on('end', function (err) {});

Report can be any js object containing primitive types (Number / String / Date) with any array/object nesting. Report is JSON stringified on file system.

Date identification

History store needs to know date of report. By default, date is expected to be found in report.date. However, it is possible to define specific access to date.

// date identified by report.creationdate
stores.report('MyReport', 'creationdate')

// date identified in nested object report.status.date
stores.report('MyReport', 'status.date')

// date identified with a custom function computeDate(report) { ... }
stores.report('MyReport', computeDate)