zeke/path-is-fresh

🌺 A human-friendly tool for checking file freshness

path-is-fresh

A human-friendly tool for checking file freshness

Installation

npm install path-is-fresh --save

Usage

The module exports a single function:

const pathIsFresh = require('path-is-fresh')

The first argument should be a fully-qualified path to a file or directory:

pathIsFresh('/some/file-created-in-the-last-hour.txt')
// true

pathIsFresh('/some/file-created-ages-ago.txt')
// false

To customize the freshness threshold, specify a human interval string like 10 seconds or 1 minute or 3 days as the second argument:

pathIsFresh('/some/file.txt', '3 weeks')
// true

If the given path doesn't exist, the function will return false:

pathIsFresh('nonexistent-file')
// false

Tests

npm install
npm test

Dependencies

• human-interval: Human readable time measurements

Dev Dependencies

• chai: BDD/TDD assertion library for node.js and the browser. Test framework agnostic.
• mocha: simple, flexible, fun test framework
• standard: JavaScript Standard Style
• standard-markdown: Test your Markdown files for Standard JavaScript Style™
• timekeeper: Easy testing of time-dependent code.
• tmp: Temporary file and directory creator

License

MIT