FileCache
A file cache class for ES6.
Install
$ npm install class-file-cache
Usage
const FileCache = const fileCache = fileCache const file = fileCache
FileCache
Class: This class inherits from Map
.
options
The default options
:
maxAge: 0 cacheControl: 'public,max-age=#maxAge' md5Encoding: 'hex' ignores: 'node_modules'
fileCache.load(directory)
directory
String
Load and cache files from directory
.
fileCache.ignore(name, name, ...)
name
String
Ignore the file by name
. Example:
Example, Ignore all '.log' files:
fileCache
fileCache.extra(loader)
loader
Function
Add a extra loader
for use it to get file details when load files.
The loader
gets two arguments (path, file)
, load the path
of file
and save the details to file
object, example:
fileCache
License
(The MIT License)
Copyright (c) 2015-2016 Kan Kung-Yip <gon@gyeq.in>
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the 'Software'), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.