Configuration

Minimal usage

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

const cache = new FileSysCache({
    basePath: './.file-sys-cache'
});

Key	Type	Default	Description
`basePath`	`string`	./.file-sys-cache	Directory where cache will be stored
`defaultTTL`	`number`	60	Expiration time in seconds
`hash`	`THashOptions`	sha256	Hashing algorithm
`debug`	`boolean`	false	Enables debug mode
`autoInvalidate`	`boolean`	false	Auto invalidate files from file-system and delete expired files automatically without need of triggering .invalidate()
`enableMonitoring`	`boolean`	false	Enabled monitoring which exposes cache.monitoring.get(), cache.monitoring.reset()

Hash Options

type THashOptions = 'RSA-MD5' | 'RSA-RIPEMD160' | 'RSA-SHA1' | 'RSA-SHA1-2' | 'RSA-SHA224' | 'RSA-SHA256' | 'RSA-SHA3-224' | 'RSA-SHA3-256' | 'RSA-SHA3-384' | 'RSA-SHA3-512' | 'RSA-SHA384' | 'RSA-SHA512' | 'RSA-SHA512/224' | 'RSA-SHA512/256' | 'RSA-SM3' | 'blake2b512' | 'blake2s256' | 'id-rsassa-pkcs1-v1_5-with-sha3-224' | 'id-rsassa-pkcs1-v1_5-with-sha3-256' | 'id-rsassa-pkcs1-v1_5-with-sha3-384' | 'id-rsassa-pkcs1-v1_5-with-sha3-512' | 'md5' | 'md5-sha1' | 'md5WithRSAEncryption' | 'ripemd' | 'ripemd160' | 'ripemd160WithRSA' | 'rmd160' | 'sha1' | 'sha1WithRSAEncryption' | 'sha224' | 'sha224WithRSAEncryption' | 'sha256' | 'sha256WithRSAEncryption' | 'sha3-224' | 'sha3-256' | 'sha3-384' | 'sha3-512' | 'sha384' | 'sha384WithRSAEncryption' | 'sha512' | 'sha512-224' | 'sha512-224WithRSAEncryption' | 'sha512-256' | 'sha512-256WithRSAEncryption' | 'sha512WithRSAEncryption' | 'shake128' | 'shake256' | 'sm3' | 'sm3WithRSAEncryption' | 'ssl3-md5' | 'ssl3-sha1'

IntroductionGetting Started

ApiFunctions