date-store
v1.0.1
Published
Easily persist or get stored dates/times. Useful for conditionally making updates in an application based on the amount of time that has passed.
Downloads
834
Maintainers
Readme
date-store
Easily persist or get stored dates/times. Useful for conditionally making updates in an application based on the amount of time that has passed.
Please consider following this project's author, Jon Schlinkert, and consider starring the project to show your :heart: and support.
Install
Install with npm:
$ npm install --save date-store
Usage
const DateStore = require('date-store');
API
Params
name
{String}: Ifoptions.path
is supplied,name
will be ignored. Otherwisename
is used as the filename for the JSON store:~/.date-store/{name}.json
options
{Object}: Optionally pass adir
and/orpath
to use for the JSON store. Default is~/.date-store.json
Example
const store = new DateStore();
Params
key
{string}returns
{object}: Returns the instance for chaining.
Example
store.set(key);
Params
key
{String}: The name of the stored date to get.returns
{Date}: Returns the date object forkey
Example
store.set('foo');
console.log(store.get('foo'));
//=> Mon Apr 11 2016 06:18:31 GMT-0400 (EDT)
console.log(store.get('foo') instanceof Date);
//=> true
Params
key
{String}: The name of the stored date to get.returns
{String}: Returns the stringified date forkey
Example
store.set('foo');
console.log(store.getRaw('foo'));
//=> Mon Apr 11 2016 08:39:10 GMT-0400 (EDT)
console.log(store.getRaw('foo') instanceof Date);
//=> false
console.log(store.get('foo') instanceof Date);
//=> true
Params
key
{String}: The name of the stored date to get.returns
{Number}
Example
store.set('foo');
console.log(store.getTime('foo'));
//=> 1460378350000
Params
key
{String}returns
{Boolean}
Example
store.set('foo');
console.log(store.has('foo'));
//=> true
Params
key
{String|Array}: Property name or array of property names.returns
{Object}: Returns the instance for chaining.
Example
store.del('foo');
Params
str
{String}: A human-readable string to pass to date.jsreturns
{Date}: JavaScript Date object
Example
console.log(store.date('1 day from now'));
//=> Tue Apr 12 2016 10:05:12 GMT-0400 (EDT)
Params
timespan
{String}: A human-readable string to pass to date.jsreturns
{Date}: JavaScript Date object
Example
console.log(store.date('1 day from now'));
//=> Tue Apr 12 2016 10:05:12 GMT-0400 (EDT)
Params
key
{String}: The stored date to comparetimespan
{String}: A human-readable string to pass to date.jsreturns
{Number}: The difference in seconds between the two dates, orNaN
if invalid.
Example
console.log(store.diff('foo', '10 minutes ago'));
//=> 338563
Params
key
{String}: The name of the stored date to set on.current
returns
{Object}: Returns the instance for chaining.
Example
store.set('bar');
store.lastSaved('bar');
console.log(store.current);
//=> 1460378350000
console.log(store.lastSaved('bar').moreThan('31 minutes ago'));
//= false
console.log(store.lastSaved('bar').lessThan('31 minutes ago'));
//=> true
Params
key
{String}: The name of the stored date to set on.current
returns
{Object}: Returns the instance for chaining.
Example
store.set('bar');
console.log(store.lastSaved('bar').moreThan('31 minutes ago'));
//= false
console.log(store.lastSaved('bar').lessThan('1 minutes ago'));
//=> true
Params
key
{String}: The name of the stored date to set on.current
returns
{Object}: Returns the instance for chaining.
Example
store.set('bar');
console.log(store.lastSaved('bar').moreThan('31 minutes ago'));
//= false
console.log(store.lastSaved('bar').lessThan('1 minutes ago'));
//=> true
Params
timespan
{String}: A human-readable string to pass to date.jsreturns
{Array}: Returns an array of keys
Example
var keys = store.filterSince('1 week ago');
.clear
Reset store.dates
to an empty object.
returns
{undefined}
Example
store.clear();
.json
Stringify the store. Takes the same arguments as JSON.stringify
.
returns
{string}
Example
console.log(store.json(null, 2));
.save
Calls .writeFile() to persist the store to the file system, after an optional debounce period. This method should probably not be called directly as it's used internally by other methods.
returns
{undefined}
Example
store.save();
.dates
Getter/setter for the store.dates
object, which holds the values that are persisted to the file system.
returns
{object}
Example
console.log(store.dates); //=> {}
store.set('foo');
store.set('bar');
console.log(store.dates);
// { foo: 'Mon Apr 11 2016 08:39:10 GMT-0400 (EDT)',
// bar: 'Mon Apr 11 2016 08:39:10 GMT-0400 (EDT)' }
About
Pull requests and stars are always welcome. For bugs and feature requests, please create an issue.
Running and reviewing unit tests is a great way to get familiarized with a library and its API. You can install dependencies and run tests with the following command:
$ npm install && npm test
(This project's readme.md is generated by verb, please don't edit the readme directly. Any changes to the readme must be made in the .verb.md readme template.)
To generate the readme, run the following command:
$ npm install -g verbose/verb#dev verb-generate-readme && verb
Related projects
You might also be interested in these projects:
- data-store: Easily persist and load config data. No dependencies. | homepage
- nanoseconds: Convert the process.hrtime() array to a single nanoseconds value. This makes it easier to diff… more | homepage
- time-stamp: Get a formatted timestamp. | homepage
Author
Jon Schlinkert
License
Copyright © 2018, Jon Schlinkert. Released under the MIT License.
This file was generated by verb-generate-readme, v0.6.0, on May 29, 2018.