@speedy/require-cache/dist/require-cache.model.d.ts

Speed up Node load time by caching resolved module paths to avoid module resolution and refetching each time the application is loaded.

export interface CacheOptions {
    /**
     * Used to invalidate the cache. By default it's set the version of `package.json`.
     *
     * Normally one will pass the application version number assuming that a different version
     * or a Unix timestamp when the cache should expire.
     *
     * string: 'package.json' version: `1.0.0`.
     *
     * number: Unix timestamp: `1490873027`.
     */
    cacheKiller: number | string;
    /** Alternate cache file location. Default: `./.cache/speedy-require-cache.json` */
    cacheFilePath: string;
    /** When in `ReadOnly` mode. Any changes will be discharged once process is terminated. Default: `false` */
    readOnlyMode: boolean;
}
export interface CacheStats {
    /** Number of modules who's locations were found in the cache. */
    cacheHit: number;
    /** Number of modules who's locations were not found in the cache and were added to the cache. */
    cacheMiss: number;
    /** Number of modules not to be cached - either not in `node_modules` folder or `process.cwd()` */
    notCached: number;
}