Skip to content

Latest commit

 

History

History
59 lines (43 loc) · 2.54 KB

README.md

File metadata and controls

59 lines (43 loc) · 2.54 KB
Raw

File-Sys-Cache

File-Sys-Cache is an npm package that provides a simple and efficient system files-based caching solution for Node.js applications.

Features

  • Set Cache: Store data in the cache with options to specify file name prefix, file name, payload, and time-to-live (TTL).
  • Get Cached Data: Retrieve cached data by providing the corresponding file name or prefix.
  • Invalidate Cached Data: Automatically invalidate cached data for items with expired TTLs.
  • Flush Cache by Regex: Flush cache entries that match a given regular expression.
  • Flush Whole Cache: Clear the entire cache, removing all stored entries.
  • Monitoring: Monitor cache usage and performance statistics, including invalidated files count, logs over time, size over time, and request count.
  • TypeScript: Full TypeScript support

Installation

Install File-Sys-Cache via npm:

npm install file-sys-cache

Usage

import { FileSysCache } from 'file-sys-cache'

// Create a new cache instance
const cache = new FileSysCache({
    basePath: './.file-sys-cache', // Directory where cache will be stored
    defaultTTL: 60, // 60 seconds expiration time
    hash: 'sha256', // Hashing algorithm
    debug: false, // Enabled debug mode
    autoInvalidate: false, // Auto invalidate files from file-system and delete expired files automatically without need of triggering .invalidate()
    enableMonitoring: false // Enabled monitoring which exposes cache.monitoring.get(), cache.monitoring.reset()
});

// Set cache with a file name prefix, file name, payload, and TTL
await cache.set({ fileName: 'myFileName', key: 'myUniqueKey', payload: myPayload, ttl: 3600 })

// Retrieve cached data by file name prefix and file name
const data = await cache.get({ fileName: 'myFileName', key: 'myUniqueKey' });

// Retrieve current list of files inside cache
const data = await cache.files();

// Flush cache by passing regex
await cache.flushByRegex('myString', 'myString2'); // Flush cache by regex match (single or multiple same matches)

// Flush whole cache
await cache.flushAll();

For more detailed usage examples and API documentation, please refer to the Documentation section.

Contributing

Contributions are welcome! Please see the Contributing Guidelines for more information.

License

This project is licensed under the MIT License - see the LICENSE file for details.