ensure-path-cached
v1.1.0
Published
native ES6 ESM module, ensures path exits, shortcut for ensuring periodic dir, uses cache to avoid unnecessarily accessing remote fs, i.e., NFS/EFS
Downloads
6
Maintainers
Readme
ensure-path-cached
- native ESM, type: module (.mjs)
- Ensures pre-existing dirs already exists
- Ensures path to create exists or creates it
- Periodic dir specified with Luxon format string
- Caches path:dir with TTL and maxEntries avoiding unnecessarily filesystem access
Usage
import EnsurePathCached from 'ensure-path-cached.mjs'
const ensurePathCached = new EnsurePathCached()
try {
// preExistingPath is optional and defaults to process.cwd()
await ensurePathCached.ensurePathExists(pathPrefixToCreate, preExistingPath)
/*
* OR
*
* <pre>
* properties = {
* preExistingPathPrefix: <String>, // optional path prefix must exist and must not end with / or throws Error, default process.cwd()
* pathPrefixToCreate: '/fubar', // optional path relative to preExistingPath must start with /, default ''
* date: <Date>, // optional date for computing periodic dir, default now in UTC
* dateTimeFormatString: 'yyyyMMdd', // optional luxon format string, default yyyyMMdd
* }
* </pre>
*/
await ensurePathCached.ensurePeriodicDirAtPathExists(properties)
} catch (e) {
// handle error
}